Skip to main content

Server-side API Authorization

  • Base URL: https://api.adapty.io/api/v2/server-side-api/

  • Authorization header: API requests must be authenticated with your secret API key. You can find it in the App Settings.

    Format of the value is Api-Key {YOUR_SECRET_API_KEY}, for example, Api-Key secret_live_Pj1P1xzM.3CvSvE3IalQRFjsWy3csBVNpH71atnod.

  • Headers: Use one of the following to identify the user profile

    • adapty-profile-id: The user’s Adapty profile ID, visible in the Adapty ID field in the Adapty Dashboard -> Profiles -> specific profile page.
    • adapty-customer-user-id: The user’s ID in your system, visible in the Customer user ID field in the Adapty Dashboard -> Profiles -> specific profile page. ⚠️ This works only if you identify users in your app code using the Adapty SDK.

  • adapty-platform header: Use this header to specify the app's platform. Possible options include: iOS, macOS, iPadOS, visionOS, Android.

  • Content-Type header: Set the Content-Type header to application/json for the API to process your request.

  • Body: The API expects the request to use the body as JSON.

Postman collection and environment​

To simplify using our server-side API, we've prepared a Postman collection and an environment file you can download and import into Postman.

  • Request Collection: Includes all requests available in the Adapty server-side API. Note that it uses variables that you can define in the environment.
  • Environment: Contains a list of variables where you can define values once. After making this environment active, Postman will automatically substitute the defined variable values in your requests.
tip

Download the collection and environment

For info on how to import a collection and environment to Postman, please refer to the Postman documentation.

Variables used​

VariableDescriptionExample Value
secret_api_keyYou can find it in the Secret key field in the App settings.secret_live_Pj1P1xzM.2CvSvE1IalQRFjsWy6csBVNpH33atnod
adapty-customer-user-idThe user ID used in your system. In the Adapty Dashboard, you can find it in the Customer user ID field of the Profile.[email protected]
adapty-profile-idThe user ID assigned in Adapty. In the Adapty Dashboard, you can find it in the Adapty ID field of the Profile.3286abd3-48b0-4e9c-a5f6-ac0a006333a6
adapty-platformThe platform used by the user for your app. Possible values: iOS, macOS, iPadOS, visionOS, Android.iOS
stripe_tokenToken of a Stripe object representing a unique purchase, such as a Subscription (sub_XXX) or Payment Intent (pi_XXX).sub_1JY8xLLy6P12345a

What's next: