Deprecated
If you are new to the Apps Management API, please refer to the v2 docs.
We’ve made some changes to v1 in the wake of the v2 release. These changes are emphasized below. If you use v1, you should plan a migration to v2. Please see our migration guide.
The Akoya Apps Management API helps you create and update your applications on the Akoya network. You may also search for providers and request subscriptions for the data you need.
Overview
Sign up for the Hub
Your first step is to join the Akoya network through the Data Recipient Hub. The Hub allows you to create an app in sandbox and test our product 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.
Note
Please log into the Data Recipient Hub for your 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 guide for the Service tokens API.
When creating apps, you must specify which Akoya products your app will use and make subscription requests. A subscription links your application to the Akoya products your app will use and the data providers that have activated your subscription.
Create apps
Note
You may create and update up to 10 apps in the Akoya sandbox.
When creating apps, you must specify which Akoya products your app will use and make subscription requests. A subscription links your application to the Akoya products your app will use and the data providers that have activated your subscription.
New
The API will auto-subscribe any new apps you create to all providers that support the Akoya products the new apps use. Your apps will then auto-subscribe to any new providers that we add to our network.
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: https://sandbox-api.akoya.com
- Production: https://api.akoya.com
Features
The Apps Management API allows you to mange or search your app('s) details, Akoya products, and your subscriptions.
Apps
Create your app(s)
This endpoint allows you to create applications via API. You must provide name, redirect URIs, contacts, description, and links to the app logo. You may also include a link to your app's icon.
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 name, redirect URIs, contacts, description, logo, and icon updates.
Remove your app
You may also delete applications.
Products
To get lists of your subscribed Akoya products and which providers support the Akoya products you’re interested in, use the Subscribed products or Providers by Akoya product endpoints.
Subscriptions
The Apps Management API has several endpoints to help you manage subscriptions. App subscription details will list subscription information for each or your applications. This information includes subscribed Akoya products and providers, including which account category the provider supports for the subscription. You may also use Subscription status by app to get a list of list your application's subscription status for each provider.
Create or add subscriptions
New
Any new apps created will be auto-subscribed to all providers on our network. New providers will be added automatically as they come onto our network. If you want to subscribe existing apps to all providers, you have two options:
- Wait until v1 is sunset (date to be determined in the December 2024 timeframe). All your apps will be auto-subscribed to all providers at that time.
- Contact your Customer Success Manager.
Change log
| Date | Change |
|---|---|
| 2024-Aug-15 | Original |
Need help?
Check out our Developer Community, or visit the Support Center in the Data Recipient Hub.
Looking for provider nuance documentation?
All provider nuance documentation is available in the Data providers section in the Data Recipient Hub.
Still stuck?
For all production issues, submit a support ticket through the Data Recipient Hub. Our support team is standing by 24/7. Questions and non-production issues will be answered during business hours.