DQE Exit Criteria

Data Qualification Exit Criteria

1. Correct any items listed in your data qualification progress report.

• The report will list items as "Required to fix," "Recommended to fix," and "Good to fix."
• Items to correct are listed in a PDF progress report. Be sure to apply corrections from all data qualification reports.

2. Repeat Request Data Qualification Verification and View Data Qualification Progress Reports processes.

• Be sure to request an updated report after you have applied corrections.

3. Repeat steps 1 and 2 until you receive an email from Apple Business announcing that you have passed data qualification.

• When data qualification passes, Apple Business will send an email announcing that your data is approved for launch to production.

4. Proceed to Step 4: Launch to Production.

Test Share Access in AIE/DQE

Partners can test Share Access functionality during the DQE phase with more capabilities than in AIE. This testing helps partners prepare for production Share Access implementation.

Important: Testing Share Access during onboarding is different from activating Share Access in production. See Prerequisites for Share Access for production requirements.

Testing in AIE:

• Delegation: Not supported.
• OAuth app: Restrictions apply:
  • Test organizations only.
  • Requires approval from Apple Business support.
  • To enable OAuth app testing in AIE, email Apple Business support.

tip

While testing in AIE is possible, many partners find it easier to complete onboarding through production launch first, then set up and test Share Access in DQE where both methods are fully supported.

Testing in DQE:

• Share Access Supported: Delegation and OAuth app testing are available in DQE.
• Test Accounts: Apple Business provides test accounts for Share Access testing.
• Limited Scope: Testing is limited to test organizations and temporary endpoints.
• Timing: Available after data qualification exit criteria are met.

To test Share Access in DQE:

1. Request to test Delegation or OAuth app features for a test account's cover photo and logo, showcases, and insights. Send the request email to Apple Business partner support.
2. Apple Business support will send a request for the specific information needed for the Share Access method you are testing (e.g., brand names and countries).
3. Complete the testing based on the Share Access method:

Delegation

1. Use the provided DQE test account as the brand/organization.
2. Delegate the brand to the test account.
3. Apple Business will set up the brands so you can test sending delegated data with the brand orgId and brandId and your own service account client_secret API keys.
4. Use the test account orgId and brandId as an access token for the brand to create and manage locations, cover photos, showcases, flexible action links, and notifications.

OAuth app

1. Use the provided DQE test account as the brand/organization, and use the provided URL as the partner domain redirect_uri for the OAuth app. Multiple URIs are possible, but only https with a valid signature is allowed.

• You cannot test the organization steps for connecting the organization to the partner website to Apple Business.

2. Use the access token for the test account organization to create and manage locations, cover photos, showcases, flexible action links, and notifications.
3. Apple Business will set up the brands so you can test sending OAuth app data using the test organization’s orgId and the access token returned by the Request Access Token and Request Refresh Token API.
4. Use the test account and returned tokens for access to create and manage brand locations, cover photos, showcases, flexible action links, and notifications.

4. Verify the API. After your Share Access is approved and connected, confirm that your Apple Business data updates correctly.

Create brands. See Business API > Brand > Create.
Update brands. See Business API > Brand > Update.
Get brands. See Business API > Brand > Get.
Delete a brand. See Business API > Brand > Delete.
Create locations for the created brand. See Business API > Location > Create.
Update a location. See Business API > Location > Update.
Get a location. See Business API > Location > Get.
Delete a location. See Business API > Location > Delete.
Create a showcase for a brand. See Business API > Showcase > Create.
Get notifications. See Business API > Events > Get Notifications.

note

Get notifications will return empty list if notifications have not yet been generated.