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

AccelByte Platform API

Commerce - stores, items, entitlements, wallets, orders.

AccelByte Platform API is one of 13 APIs that AccelByte publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 4 operations across 4 paths, and defines 9 schemas. It is described by OpenAPI 3.0.3, at version 1.0.

Requests are made against 2 base URLs: https://demo.accelbyte.io, https://{namespace}.accelbyte.io.

4 operations 4 paths 9 schemas 3 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0
Base URL
https://demo.accelbyte.io/iam
Authentication
HTTP Bearer, HTTP Basic
Contact
Terms of Service
Resource Areas
1

Authentication & Security 2

AccelByte Platform API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). It accepts HTTP basic authentication (basicAuth). By default, every request must be authenticated.

  • bearerAuth — OAuth2 access token issued by the IAM token endpoint.
  • basicAuth — OAuth2 client id / client secret used at the token endpoint.

Paths & Operations 4

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

Platform 4

Commerce - stores, items, entitlements, wallets, orders.

GET
/platform/public/namespaces/{namespace}/items/byCriteria
Query catalog items by criteria.
platformQueryItems 4 params → 200
GET
/platform/public/namespaces/{namespace}/users/{userId}/entitlements
List a user's entitlements.
platformGetUserEntitlements 4 params → 200
POST
/platform/public/namespaces/{namespace}/users/{userId}/orders
Create an order (checkout).
platformCreateOrder 2 params body → 201
GET
/platform/public/namespaces/{namespace}/users/{userId}/wallets/{currencyCode}
Get a user's wallet for a currency.
platformGetUserWallet 3 params → 200

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are Entitlement (7 properties), Item (6 properties), Wallet (6 properties), Order (6 properties). Each schema is shown below with its type and property counts.

Wallet
object
6 properties
OrderRequest
object
5 properties 2 required
Entitlement
object
7 properties
RegionPrice
object
4 properties
Order
object
6 properties
EntitlementPagedResponse
object
2 properties
Item
object
6 properties
ItemPagedResponse
object
3 properties
Paging
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

accelbyte-platform-api-openapi.yml Raw ↑

Other APIs AccelByte publishes across the network.

AccelByte Achievement API
AccelByte Basic API
AccelByte Cloud Save API
AccelByte DSMC API
AccelByte Game Telemetry API
AccelByte IAM API
AccelByte Leaderboard API
AccelByte Matchmaking API
AccelByte Season Pass API
AccelByte Session API
AccelByte Statistics API
AccelByte UGC API