Webshop Admin API reference

Explore the Webshop Admin API endpoints you can use to configure webshops, environments, themes, and branding programmatically.

Read time 1 minute

Last updated 16 days ago

The recommended best practice is for administrators to configure webshops in the Unity Dashboard. Use the Webshop Admin API when the Unity Dashboard doesn't fit your workflow, such as when you need to do the following:

Update themes across many environments.
Script webshop creation as part of project setup.
Integrate webshop configuration into your deployment pipeline.

This page links to the API reference and explains how authentication and authorization work for admin-API calls.

Authentication

The Admin API uses Service Account credentials. Generate a Service Account key from the Unity Dashboard, base64-encode the

key_id:secret_key

pair, and send it as a Bearer token in your requests. For step-by-step instructions, refer to the Service Account authentication guide.

Authorization

Each Admin API endpoint requires a specific Service Account role. For the role list and the per-operation requirements, refer to Webshop permissions reference.

API reference

Webshop Admin API referenceOpenAPI reference for every admin endpoint.

Documentation

Development

User Acquisition

Monetization

Industry

Documentation

Development

User Acquisition

Monetization

Industry

In-App Purchasing

IAP Client API

IAP SDK API