Production Launch

Onboarding Progress

Step 1: Getting Started ✓
Step 2: API Integration (AIE) ✓
Step 3: Data Qualification (DQE) ✓
Step 4: Production Launch

Step 4: Launch to Production

In this final step, you will gain access to the production environment and begin streaming all of your production data through the Business API.

1. You will receive an email from Apple Business granting you access to the production environment.

• Retrieve the production environment endpoint from the email.

2. Create a Service Account for the production environment.

• This service account will be used for both production evaluation and long-term production purposes.

3. Collect the Integration Parameters.
4. Confirm your availability with Apple Business partner support so that Apple Business can schedule a launch date and time for you to start sending data to production.
5. On your scheduled launch day, wait for Apple Business to give you the signal to start, and then begin sending your data.

• On launch day, you and Apple Business support will communicate through a live WebEx meeting or through email until final approval is granted.

note

You must wait for Apple Business's signal before sending any data to the Production environment.

important

Existing Partners Only

• If you previously delivered data to Apple using site_code, make sure the site_code values match the Business API > Resource Definitions > locationDetails > partnersLocationId values.
• You must stop uploading all existing files to the Box folder. Apple will disable the ingestion of bulk data files from existing partners before enabling their Business API production path.

6. Be prepared to pause the API upload when requested by Apple Business. Typically, this pause is requested after the first 5,000 records have been ingested.

• Apple Business will verify the data you have submitted so far.

7. If you receive notification of any issues, correct the issues that are presented.
8. When Apple Business notifies you that you are approved for streaming to production, you can submit your remaining data.

Production Onboarding Complete

When you have submitted your full dataset, you are fully onboarded with the Business API.

• With this final approval, you have access to all of the Business API for use with brands and locations.
• You can continue to send and apply updates through the Business API to production. Production data is live on Maps and across the Apple ecosystem of products.
• You must respect the agreed-upon rate limit for your data submission.
• After your client organizations Share Access with you, you can provide showcases, cover photos, and logos, set up flexible action links, and collect insights. See Delegation and OAuth app.

Share Access in Production

After completing all onboarding phases and successfully sending undelegated data to production, you can activate Share Access features. This section covers the setup and implementation for both OAuth app and Delegation.

See Share Access Benefits.

Share Access Setup

1. The organization registers with Apple Business and creates brands and locations.
2. The organization invites or allows you to Share Access using one of the following methods:

Delegation

1. From the Apple Business portal, the organization invites you to Share Access using the Delegation.
2. You will receive an email invitation to accept delegation from the organization.

OAuth app

1. You register your OAuth app with Apple Business.
2. You build an authorization flow on your platform, including a link to the OAuth app in the Apple Business portal.
3. The organization connects to you through the OAuth app. From your platform, the organization chooses to connect to their Apple Business account.
4. The organization allows the connection. From Apple Business, the organization allows you to Share Access through the OAuth app.

3. You will receive an invite or approval to Share Access with the organization, depending on the Share Access method:

Delegation invitation

1. An email invitation is sent to the team members in your organization who have an administrator role.
2. You can accept the invitation to be a delegated partner through either the Apple Business portal or the email link.
   • A delegation invitation is required to be accepted, but only once per organization.
   • Delegation invitations expire after 30 days. If you do not accept within this period, the organization must re-share their delegation in Apple Business.

OAuth app organization approval

You will receive a notice from Apple Business that the organization has allowed Share Access using your OAuth app.

Send Data with Share Access

1. Verify that the brand state is PUBLISHED by calling Business API > Events > Get Notifications and checking for a delegation event.

• The brand must be published and approved before you can begin sending data.

2. Best Practice: Check what brand locations already exist by using the Business API > Location > Get.

• Periodically calling this API helps ensure that you stay in sync with existing brand locations and helps to avoid creating duplicate locations. Use the Business API > Delegation > Get Matching Location to request a list of delegated brand locations that match your own.

3. Stop sending brand and/or location data using your own partner orgId.
4. Create and update brand and location data for the organization, using the credentials for the Share Access method.
5. Check notifications for the statuses of your submitted resources every 15 minutes. See Notification and Feedback.

• If you receive an error Brand must upload document or complete phone verification for location ‘{{id}}’ to initiate claim validation, contact your brand and have them complete the verification of the new location.