Skip to main content

AIE Exit Criteria

To complete the API integration (AIE) phase, you must integrate and test each of the API that have been assigned to you. Passing these tests is an exit requirement.

See the Business API for detailed information about each API.

Location

If assigned, you must complete the following:

important

partnersLocationId values used in AIE are temporary. In the DQE phase, the partnersLocationId values you use must be the same as the ones you will use in production.

Create at least 100 unique locations. It is recommended that you create locations from a mixed set of brands and categories. See Business API > Location > Create.
Update openingHoursByDay for at least 5 locations, so that the hours are weekdays only, 8 a.m. to 5 p.m., and closed on Saturday and Sunday. See Business API > Location > Update.
Update displayNames for 3 locations. See Business API > Location > Update.
Delete at least 5 locations. See Business API > Location > Delete.
Undelete at least 3 of the locations you deleted. See Business API > Location > Undelete.
Get at least 10 locations. See Business API > Location > Get.
Get a location using an Apple-provided identifier. See Business API > Location > Get by ID.
Get feedback for a location. See Business API > Events > Get Feedback.

Location Asset

If assigned, you must complete the following:

Create at least 12 location assets. See Business API > Location Asset > Create.
Update the caption titles for at least 3 location assets. See Business API > Location Asset > Update.
Delete at least 3 location assets. See Business API > Location Asset > Delete.
Get at least 9 location assets. See Business API > Location Asset > Get.
Get a location asset using an Apple-provided identifier. See Business API > Location Asset > Get by ID.
Get feedback for a location asset. See Business API > Events > Get Feedback.

Media

If assigned, you must complete the following:

Upload at least 20 unique images. See Business API > Media > Upload.
Get the METADATA for at least 10 images to verify that each has been accepted with a SUBMITTED state. See Business API > Media > Get Metadata.

Brand

If assigned, you must complete the following:

Create at least 3 new unique brands. See Business API > Brand > Create.
Update the categories lists of an additional 3 brands. See Business API > Brand > Update.
Delete at least 3 brands. See Business API > Brand > Delete.

Brand Asset

If assigned, you must complete the following:

Create at least 3 brand assets using 3 or more unique brandIds and 9 unique imageIds from the operations above. See Business API > Brand Asset > Create.
Update the altTexts for an additional 3 brand assets. See Business API > Brand Asset > Update.
Delete 3 brand assets. See Business API > Brand Asset > Delete.
Get at least 10 brand assets. See Business API > Brand Asset > Get.

Webhooks

Optionally, you can create one or more Webhooks to receive push messages about events. See Business API > Events > Configuring Webhooks, and the Apple Business User Guide > Set up Webhooks in Apple Business.