Spree Commerce · Authentication Profile

Spree Authentication

Authentication

Spree Commerce secures its APIs with apiKey and http across 3 declared security schemes, as derived from its OpenAPI definitions.

E-CommerceHeadless CommerceProductOrderInventoryPaymentsPromotionsOpen-SourceRuby on Rails
Methods: apiKey, http Schemes: 3 OAuth flows: API key in: header

Security Schemes

api_key apiKey
· in: header (x-spree-api-key)
bearer_auth http
scheme: bearer
orderToken apiKey
· in: header (X-Spree-Order-Token)

Source

Authentication Profile

Raw ↑
generated: '2026-07-11'
method: derived
source: openapi/spree-admin-api.yaml, openapi/spree-platform-api.yaml, openapi/spree-store-api.yaml,
  openapi/spree-storefront-api.yaml
summary:
  types:
  - apiKey
  - http
  api_key_in:
  - header
schemes:
- name: api_key
  type: apiKey
  in: header
  parameter: x-spree-api-key
  description: Secret API key for admin access
  sources:
  - openapi/spree-admin-api.yaml
  - openapi/spree-store-api.yaml
- name: bearer_auth
  type: http
  scheme: bearer
  bearerFormat: JWT
  description: JWT token for admin user authentication
  sources:
  - openapi/spree-admin-api.yaml
  - openapi/spree-platform-api.yaml
  - openapi/spree-store-api.yaml
  - openapi/spree-storefront-api.yaml
- name: orderToken
  type: apiKey
  in: header
  parameter: X-Spree-Order-Token
  description: |-
    Order token to authorize Cart and Checkout requests.

    [How to obtain X-Spree-Order-Token](../authentication#for-guest-users)
  sources:
  - openapi/spree-storefront-api.yaml

Work with this as data

Every security artifact here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for security posture

4 MCP tools reach this
  • find_securityBrowse and filter every security artifact in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools

Call it yourself

curl for this page
This security artifact
curl "https://apis.io/api/v1/security/spree-authentication"
All security posture
curl "https://apis.io/api/v1/security?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

A second provider on the same verified email joins the account you already have.