Integration Parameters

Overview

Each of the three onboarding environments requires the same types of integration parameters, but with different values. You will need to gather the following parameters for the API Integration Environment (AIE), the Data Qualification Environment (DQE), and the Production Environment.

Apple-Provided Parameters

For each environment, Apple Business will provide the following:

• Endpoint: The base URL for the environment's API. You will receive this in an email from Apple Business when you are granted access to each environment.
• Rate Limit: The number of queries per second (QPS) allowed for the environment.
  • AIE: Open-ended, with the expectation of minimal queries needed for testing.
  • DQE: 15 QPS (you can request a higher limit if needed for qualification).
  • Production: 15 QPS.

Partner Registration Parameters

When you register with Apple Business, you will receive an orgId.

• Organization ID (orgId): This ID is the same across all environments. For more information, see the Apple Business User Guide > Register your Third-Party Partner or agency in Apple Business.

Service Account Parameters

When you create a Service Account for each environment, you will receive the following parameters. Be sure to save these, as they are both required for authentication.

• Client ID (client_id)
• Client Secret (client_secret)