Akoya Apps Management API v2 Guide

The Apps Management API helps you create and update your applications on the network. You may also search for providers and request subscriptions for the data you need.

Overview

Sign up for the Data Recipient Hub

Your first step is to join the network through the Data Recipient Hub. The Data Recipient Hub allows you to create an app in sandbox and test our cluster endpoints.

See Getting started.

Once you're on the network, you may use the Apps Management API to access your organization's applications.

Get credentials

The Apps Management API requires a service (access) token for your organization to use when managing your apps. To create a service token, you'll need a client id and secret.

Once you have credentials, use the service token endpoint to generate an access token which will last for 24 hours. After it expires, you will need to use your client id and secret to generate a new service token.

Service token URLs

The Apps Management API requires a service token. See the Service Token API.

You may create and update up to 10 apps in the sandbox.

When creating apps, you must specify which product your app will use and make subscription requests. A subscription links your application to the product your app will use and the data providers that have activated your subscription.

Now you're ready to create your apps! Read below for an outline of the features available to manage your apps.

Apps Management API URLs

• Sandbox: {{tenant.sandboxServiceApiURL}}

• Production: {{tenant.prodServiceApiURL}}

Features

The Apps Management API allows you to mange or search your app(s) details, clusters, and your subscriptions.

Apps

Register your app(s)

This endpoint allows you to create applications via API. You must provide the following:

• client_name (String)

• redirectUris (Array of Strings)

• contacts (Array of Strings)

• description (String)

• logo_uri (String)

• icon_url (String)

• client_uri (String)

• scope (String)

Logos and icons must be a PNG or JPG. The logo must be 240px-1024px with a max size of 2MB. The icon must be square with minimum dimensions of 40 x 40px and a maximum of 200 x 200px. The maximum size is 2MB.

List your apps

Once you've created apps, you may get a list of all apps and all details.

Update your app details

You may update your application details such as client_name, redirectUris, contacts, description, logo_uri, and icon_url updates.

Remove your app

You may also delete applications.

product

To get lists of your subscribed Akoya product and which providers support the Akoya product you’re interested in, use the Get Purchased product or Get Valid Providers for product endpoints.

Subscriptions

The Apps Management API has several endpoints to help you manage subscriptions. Get Subscriptions for App will list subscription information for each or your applications. This information includes subscribed Akoya clusters and providers, including which account category the provider supports for the subscription. You may also use Get Subscriptions for App - Filter by Status to get a list of list your application's subscription status for each provider.

Change log