Create your app(s)

✋

v1 is Deprecated

If you are new to the Management API, please refer to the v2 docs.

If you currently use v1, you should plan a migration to v2. Please see our migration guide.

Create up to fifty applications per API request.

For each app, provide name, redirectUris, clientUri, contacts, description, and links to the application logo. You may also include a link to your application's icon.

• name should be alphanumeric and may include special characters: #$&'()*+,-./|-é
  • name may not contain blocked characters: !%<>?{}[]
• description should not exceed 120 characters.
• logo URL to a file. We recommend using your full logo. We use this image for your end-user consent page. Required.
  • Minimum height: 200px
  • Minimum width: 200px
  • Maximum height: 1024px
  • Maximum width: 1024px
  • File types: transparent PNG or JPG
  • Maximum file size: 2 MB
• icon or avatar. URL to a file. We recommend using a sub-mark logo. We use this image as an avatar for your company in the Hub. Optional.
  • Must be square. Height = width.
  • Minimum height: 40px
  • Minimum width: 40px
  • Maximum height: 200px
  • Maximum width: 200px
  • File types: transparent PNG or JPG
  • Maximum file size: 2 MB

During app creation, you must also make subscription requests. A subscription links your application to the Akoya products your app has purchased and the data providers that have activated your subscription.

Each app must include at least one subscription that specifices at least one valid Akoya productand a providerId. In production, the providerId must not be mikomo.

Partial success responses

A successful 200 response may return during bulk app creation if some apps are created successfully while others have generated an error. Please check the response for error messages.

Example errors in a 200 response:

{
    "apps": [
        {
            "name": "Example app",
            "error": {
                "code": "AlreadyExists",
                "message": "This app name already exists for this recipientId."
            }
        }
    ]
}

{
    "apps": [
        {
            "error": {
                "code": "InternalServerError",
                "message": "Unable to retrieve required products"
            }
        }
    ]
}