Skip to main content

Getting Started

Welcome to the Sapera Developer Portal. This page gives you the quickest path to a first successful API call and where to go next.

Prerequisites​

  • Sandbox access (ask your Sapera contact/partner manager)
  • API credentials or token for your sandbox org
  • An HTTP client (curl, Postman, or Insomnia)
tip

Start in sandbox. Never test against production first.

Know the Map​

Sapera exposes multiple API areas (security/auth, inventory, financials, media, actors). Each service publishes a Swagger/OpenAPI UI at its own /swagger path—use it to see required fields and response shapes.

Authenticate​

Obtain a Bearer token via your tenant’s auth flow (see the security/auth service Swagger). Include the token on every request:

Example

export BASE_URL="https://YOUR_SAPERA_SANDBOX_HOST"
export TOKEN="YOUR_BEARER_TOKEN"

*Generic call template

curl -sS \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    "$BASE_URL/SERVICE_NAME/v1/ENDPOINT_PATH"

Your First Request (Paged List)​

Most list endpoints are paged. Adjust query params according to Swagger:

curl -sS \
    -H "Authorization: Bearer $TOKEN" \
    "$BASE_URL/SERVICE_NAME/v1/RESOURCE_NAME?page=1&pageSize=50"

Read total/nextPage (or similar) and loop until no more results.

Writes in Sandbox​

Try a minimal create/update using the example body from Swagger. Validate the response, then read the new item back using its ID.

Next Steps​

  • Explore each service’s Swagger to discover endpoints and required fields
  • Follow the API platform guides for end-to-end flows (products, stock, actors, orders)
Last updated on