Magento 2 REST/GraphQL API Configuration

Typical scenario: your CRM needs to push stock updates, but the standard /V1/products returns too many fields. Or your PWA frontend slows down due to N+1 queries to categories. We solve these tasks: configure authentication, write custom endpoints, implement GraphQL. The whole cycle — from analysis to deployment — takes 5 to 15 days. Experience shows that proper API configuration reduces integration time by 2–3 times.

Problems that API configuration solves

Authentication and security. A common mistake is misconfigured OAuth integration that returns 401. We set access permissions (Resource Access) so that each endpoint is accessible strictly by role. For internal services, we use token-based (Bearer) — simpler and faster. Debugging time saved — up to 2 days. Security is confirmed by regular audits.

REST performance. Without caching, bulk operations (e.g., updating 10,000 products) cause timeouts. Solution — Async REST API (POST /async/V1/products) and Varnish frontend. For public endpoints, we set up Nginx caching. As a result, TTFB drops by 3–5 times. On one project, this reduced server load by 40%.

GraphQL N+1. When requesting products with categories without DataLoader, each item spawns a separate SQL query. We use batch resolvers and aggregate the selection. GraphQL in this scenario is 2–3 times faster than REST in response size. Traffic savings up to 40%. For PWA frontends this is especially critical — pages load in 1–2 seconds.

Why choose a custom endpoint?

Standard endpoints do not cover business specifics. Example: you need to return view statistics and stock data in one response. We implement an interface:

interface ProductStatsInterface {
    public function getStats(string $sku): array;
}

In the class, we inject ProductRepositoryInterface and StockRegistryInterface. We return price, quantity, stock status. The route is configured in etc/webapi.xml. One endpoint instead of two — less traffic and faster development.

How to configure authentication for external services?

For external services (CRM, ERP), we use OAuth 1.0a. An integration is created in the admin panel, generating Consumer Key/Secret and Access Token/Secret. Each request is signed, providing high security. For internal integrations, token-based is sufficient: POST /V1/integration/admin/token returns a token valid for 1 hour. If longer is needed, we configure refresh tokens.

Process

1. Analysis — identify bottlenecks: slow queries, redundant data, wrong roles.
2. Design — choose protocol (REST/GraphQL), design endpoint schema, write tests.
3. Implementation — write modules, configure ACL, optimize queries. For bulk operations — Async API with RabbitMQ.
4. Testing — load tests with JMeter, check Core Web Vitals (LCP, TTFB). Ensure API handles 1000 RPS.
5. Deployment — deploy with Varnish and Redis, deliver Postman collection and GraphQL schema, train the team.

How to avoid rate limiting during bulk operations?

For integrations with large volume (e.g., loading 10,000 products), we use Bulky API: send a request to /async/V1/products with an array of products. Magento processes them asynchronously, without blocking the thread. If feedback is needed, we subscribe to the product_action_notification queue. This bypasses limits and maintains performance. This solution has been proven on projects with 50,000+ products.

REST vs GraphQL Comparison

Authentication Methods Comparison

What's included

• Authentication configuration (Token/OAuth) and ACL.
• Development of custom REST/GraphQL endpoints for business logic.
• Performance optimization: caching, async queues, DataLoader.
• API documentation (Postman, GraphQL schema) and team training.
• Compatibility guarantee with latest Magento versions and PHP 8.2+.
• Post-deployment support: monitoring, rate-limiting fixes, enhancements.

Estimated timeline: 5 to 15 days. Cost is calculated individually after project analysis. We have been working with Magento for over 8 years and have participated in 30+ integrations. Leave a request — we'll evaluate your project in 1 day. Contact us for a consultation — our engineers will help you choose an integration method and optimize your API. Order Magento 2 API configuration — we guarantee performance and security.

Magento REST API Documentation

API Development with REST, GraphQL, WebSocket, and tRPC

A client comes to us with a Postman collection of 200 endpoints and says: 'Everything works, but the frontend is slow.' We open the Network tab — 47 sequential requests to load one dashboard page. Each one waits for the previous. This is not a server speed issue — it's an API architecture problem. With 10 years on the market, we've redesigned dozens of such integrations, and we guarantee: the right protocol and contract solve the problem at its root.

When REST stops being enough

REST works well for simple CRUD operations. But as soon as a mobile app appears alongside the web interface, over-fetching begins: the mobile app requests /api/users/123 and gets a 4KB object, but only needs name and avatar. Multiply that by a list of 50 users — 200KB traffic instead of 8KB.

GraphQL solves this with selection sets. The client describes exactly the fields it needs, and the server returns only those. On a project with React Native + Next.js, we migrated from REST to Apollo Server: payload size on the main screen dropped from 340KB to 28KB — a 92% traffic savings. Our certified engineers confirm: the typical pain when adopting GraphQL is N+1 query. A resolver for the author field on a post calls SELECT * FROM users WHERE id = ? for each post in the list. On a page with 20 posts — 21 database queries. Solved with DataLoader — it batches queries and turns them into one SELECT * FROM users WHERE id IN (...).

What is tRPC and how is it better than REST/GraphQL?

If the entire stack is TypeScript (Next.js + Node/Bun), tRPC removes a whole layer of problems. You define a procedure on the server — the client gets full type-safety automatically, without code generation and without Swagger. Renamed a field in the Zod schema — TypeScript highlights all places on the frontend where it's used. tRPC reduces code by 2 times compared to REST + Swagger + openapi-typescript: no need to maintain a separate specification and generate types — everything is inferred from runtime validators. However, tRPC is not suitable if the API is consumed by third-party clients or mobile apps in other languages — in such cases we use GraphQL or REST with OpenAPI specification.

WebSocket and real-time: when SSE, when WS?

HTTP polling every 5 seconds is an illusion of real-time with up to 5 seconds delay and useless server load. For chats, live notifications, collaborative editing — WebSocket or Server-Sent Events. SSE is a one-way stream from server to client, works over ordinary HTTP, automatically reconnects. Suitable for notifications, data streaming, progress bars. WebSocket is bidirectional, needed for chats and collaborative features. Experience shows: 80% of 'real-time' tasks are solved with SSE, not WebSocket — fewer infrastructure complexities.

A typical mistake: opening a WebSocket connection for each page component. On one project, the dashboard opened 12 parallel WS connections. The correct approach is one connection manager at the application level, subscriptions through it. In our work results, we always transfer the connection scheme and a ready solution.

Swagger / OpenAPI as a contract

Documentation written after the fact becomes outdated the day after release. We write the OpenAPI 3.1 specification before development starts; it becomes the contract between frontend and backend. The frontend generates types via openapi-typescript, the backend validates incoming data using generated schemas. Contract deviation from implementation is caught on CI, not during review. For Laravel — l5-swagger or dedoc/scramble. For Node.js — @fastify/swagger or Zod + zod-to-openapi.

How to properly authenticate an API?

JWT with long-lived access tokens without rotation is a source of problems when compromised. The correct scheme: access token for 15 minutes, refresh token for 30 days with rotation on each use. Refresh token stored in an httpOnly cookie, access token in memory (not in localStorage). For inter-service communication — API Keys with scope limitations or mTLS. OAuth 2.0 with PKCE for public clients (SPA, mobile).

How to handle versioning and backward compatibility?

Breaking changes in an API without versioning break clients. Three approaches we use in projects:

We guarantee backward compatibility through automated checks (oasdiff) on CI.

How we develop APIs: step-by-step plan

1. Analysis — audit of current integrations, data schema compilation, protocol selection (REST/GraphQL/tRPC/WebSocket).
2. Contract design — OpenAPI or SDL (GraphQL) before the first line of code.
3. Development — implementation per contract, unit tests for each endpoint.
4. Load testing — k6: 500 virtual users, 10 minutes, p95 latency ≤ 200ms.
5. Deployment — CI/CD with backward compatibility check, automatic documentation publication.
6. Team training — handover of Postman collection or Playground, connection instructions.

What is included (deliverables)

• OpenAPI 3.1 specification (or SDL for GraphQL).
• Generated client types for TypeScript / Dart / Kotlin.
• Set of automated tests covering all endpoints (unit + integration).
• Load tests (k6) and report (p50/p95/p99 latency, RPS).
• Documentation in Swagger UI / Redoc / GraphiQL.
• Team training (2–4 hour workshop).
• Support for 30 days after delivery (per contract).

Our experience

• 10+ years in the API development market.
• 200+ completed projects (REST, GraphQL, WebSocket, tRPC).
• 50+ certified engineers (AWS, Kubernetes, API Design).
• Traffic savings averaging 85% when migrating from REST to GraphQL for mobile apps.
• 100% backward compatibility — not a single broken client in the last 3 years.

Timeline

API development for a typical SaaS project with 30–50 endpoints: from 3 to 8 weeks depending on business logic complexity and number of external integrations. Migration of an existing REST API to GraphQL: from 2 to 6 weeks. Adding a WebSocket layer to an existing backend: from 1 to 3 weeks. Cost is calculated individually after an audit. Get a consultation — contact us to discuss your project.