Apple Business API access for brands
You can allow third-party partners to manage brands in Apple Business using an Apple provided API.
Use the Apple Business API with logos and cover photos
Applying cover photos and logos using the Apple Business API requires that the organization and third-party partner be registered with Apple Business and that the organization successfully delegate authority to the third-party partner. See Use an Organization ID to share your content with a third-party partner.
Use the Apple Business API with showcases
Creating showcases using the Apple Business API requires that the organization and third-party partner are registered with Apple Business and that the organization successfully delegates authority to the third-party partner. See Use an Organization ID to share your content with a third-party partner.
For showcase visual elements and settings—such as call-to-action, headline and body text contents, photo, and alternative text for visually impaired—sign in and review Showcase Creative. To see the publication state and to define timeframe, resource details, and IDs, sign in and review showcase.
Service accounts
A Service Account is a special type of account intended to represent a system that needs to authenticate and be authorized to access the Apple Business API.
You can allow developers to connect to Apple Business using an Apple-provided API. To request access for a Service Account, you need to be an Organization Administrator or Marketing Administrator of a third-party partner approved by Apple.
Review the API Onboarding Guide
In Apple Business, sign in with a user whose role is an Organization Administrator or Marketing Administrator.
To view roles and permissions, see Intro to roles and permissions.
Next to API Access, select API Onboarding Guide.
You can now request API access and work with your Apple representative.
Request API access
In Apple Business, sign in with a user whose role is an Organization Administrator or Marketing Administrator.
To view roles and permissions, see Intro to roles and permissions.
Select Request API Access, then choose any of the following:
Listing management
Point of sale software
Review management
Marketing
Editorial content
Other
Select Next, then answer the questions:
Do you work directly with business owners of a physical location?
Who are your largest clients?
Select Next, then choose the data type and enter the total count.
Select Send Request.
Apple will review the request. You’ll receive an email when the review is complete.
Create a Service Account
In Apple Business, sign in with a user whose role is an Organization Administrator or Marketing Administrator.
To view roles and permissions, see Intro to roles and permissions.
Select
next to API Integration.If necessary, manually add a new user to hold the Service Account role. See Manually add a new user.
Select Add Service Account.
Provide a service name, team contact, and define the Service Account role permission—either Read + Write or Read Only.
Select Add.
The Client ID and the Client Secret Key are shown for that Service Account.
Copy this information in a safe place.
Important: If you cancel this window without copying the Client Secret Key, you need to generate a new one.
Select Done.
You’ve successfully created a Service Account.
Verify the API integration
In Apple Business, sign in with a user whose role is an Organization Administrator or Marketing Administrator.
To view roles and permissions, see Intro to roles and permissions.
Select API Integration, select Verify API Integration, then select Send.
Users who have the following roles will receive an email when the review is complete:
Organization Administrators
Marketing Administrators
Service Accounts
Qualify the API data
After you verify the API integration, you can qualify the data.
In Apple Business, sign in with a user whose role is an Organization Administrator or Marketing Administrator.
To view roles and permissions, see Intro to roles and permissions.
Select
next to Data Qualification.Do one of the following:
Select an existing Service Account.
Select Add Service Account. See Create a Service Account.
Select Verify Data Quality, then select Send.
Users who have the following roles will receive an email when the review is complete:
Organization Administrators
Marketing Administrators
Service Accounts
Publish your content to production
Use the Brand and Location API to submit your data to production for display in Maps and across Apple.
In Apple Business, sign in with a user whose role is an Organization Administrator or Marketing Administrator.
To view roles and permissions, see Intro to roles and permissions.
Select
next to Production.Do one of the following:
Select an existing Service Account.
Select Add Service Account. See Create a Service Account.
Select your API.
Remove a Service Account
In Apple Business, sign in with a user whose role is an Organization Administrator or Marketing Administrator.
To view roles and permissions, see Intro to roles and permissions.
Select API Integration.
Select Edit next to the Service Account you want to remove.
Select Remove, then select Remove.
The Service Account is removed and all its associated API connections to Apple Business are also revoked.