Onboarding Environments
Onboarding Environments
The Business API onboarding process involves three separate server environments. Each environment has a distinct purpose, connects to a different base URL, and is used to validate different functionality.
| Environment | Base URL |
|---|---|
| API Qualification (AIE) | https://aie.partner-api-business.apple.com |
| Data Qualification (DQE) | https://dqe.partner-api-business.apple.com |
| Production | https://api-business.apple.com |
API Integration Environment (AIE)
The AIE is used to test your platform's connection with the Business API using test data. This is the first environment you will use after your API access is approved.
- Purpose: Test API integration and platform connection.
- Data: Use only test data.
- Rate Limit: Open-ended, with the expectation of minimal queries needed for testing.
Data Qualification Environment (DQE)
The DQE is used to submit your production data for evaluation by Apple Business before you are granted access to the production environment.
- Purpose: Data validation and qualification.
- Data: Use only production data.
- Rate Limit: 15 queries per second (QPS).
Production Environment
The Production environment is the final stage of onboarding. In this environment, you will stream your live, production-ready location data to Apple Business.
- Purpose: Live data streaming.
- Data: Production data.
- Rate Limit: 15 queries per second (QPS).