Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

magento Authentication API

Endpoints for obtaining integration tokens for admin and customer users. Token-based authentication issues a Bearer token that must be included in the Authorization header of subsequent requests.

magento Authentication API is one of 16 APIs that magento publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Authentication. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 2 operations across 2 paths, and defines 3 schemas. It is described by OpenAPI 3.1.0, at version 2.4.

Requests are made against a single base URL, https://{store_domain}/rest/{store_code}.

2 operations 2 paths 3 schemas 2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2.4
Base URL
https://your-store.example.com/rest
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

magento Authentication API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — Bearer token obtained from the /V1/integration/admin/token or /V1/integration/customer/token endpoint. Include in the Authorization header as "Bearer {token}".

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 2 POST. Each is listed below with its method, path, parameters, and response codes.

Authentication 2

Endpoints for obtaining integration tokens for admin and customer users. Token-based authentication issues a Bearer token that must be included in the Authorization header of subs…

POST
/V1/integration/admin/token
Get admin authentication token
createAdminToken body → 200400401
POST
/V1/integration/customer/token
Get customer authentication token
createCustomerToken body → 200400401

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are Error (2 properties), CustomerTokenRequest (2 properties), AdminTokenRequest (2 properties). Each schema is shown below with its type and property counts.

AdminTokenRequest
object
Request body for obtaining an admin Bearer token.
2 properties 2 required
CustomerTokenRequest
object
Request body for obtaining a customer Bearer token.
2 properties 2 required
Error
object
Standard error response returned for 4xx and 5xx responses.
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

magento-authentication-api-openapi.yml Raw ↑

Other APIs magento publishes across the network.

Magento GraphQL API
Magento SOAP API
Adobe Commerce Webhooks
Adobe Commerce Admin UI SDK
Adobe Commerce Eventing
magento Carts API
magento Categories API
magento Customers API
magento Inventory API
magento Invoices API
magento Orders API
magento Products API