Creating a Test App

The following steps will guide you through creation of a test app in the Akoya sandbox.

Authenticate & Select Accounts

Task	Description
Review technical requirements.	See: Requirements.
Register with Akoya for sandbox access.	To register, you must provide Akoya with a redirect URI for your use with your sandbox test app. Akoya will provide you with a client Id and secret for your app.
Securely store `client_id` and `secret`	Every app has a unique client Id and secret. They must be treated as secure information and stored securely.
UX - Provider popup or redirect	Integrate into your existing provider selection UI or build popup/redirect flows for the consumer to select the data provider(s) they'd like to connect with your app. Upon consumer selection, initiate consent and authentication via Akoya to the provider. See: Native app integrations.
Use sandbox data for implementation and testing	The Akoya sandbox includes a mock data provider (Mikomo Financial) with several test users that may be used for end-to-end implementation and testing. Use these test accounts for the remaining implementation steps. See: Introduction to Sandbox.
Authorization grant	After authentication and authorization, Akoya will return the consumer to your redirect URI with an authorization grant code in the URL with the parameter “code=”. Use this authorization code to request a set of tokens for this consumer. See: Authorization Code.
Store `x-akoya-interaction-id`	Akoya returns an interaction id in every response header. Retain the id with logs for support and error tracking.
Id and refresh token generation	Exchange authorization code for ID and refresh token See: Token API reference and the token explainer.
Store token	Use your current secure token storage or implement a way to store each consumer's unique tokens.
Token revocation	Implement a way for the consumer to remove access to their data provider account(s). See Revoke Token.
Error cases	Code for authorization or token errors. Develop UX for errors, timeouts, and reauthentication. See Authentication errors and Token API errors.
Validate authentication	Validate UX for account selection, consent, ID/refresh token for new and existing users.

Obtain Data

Task	Description
Store `x-akoya-interaction-id`	Akoya returns an interaction id in every response header. Retain the id with logs for support and error tracking.
Accounts	Using the `id_token` retrieved in the Id and refresh token step above for a test user, make a call for data. See: API Docs - Accounts info reference.
Transactions	Using the `id_token` retrieved in the Id and refresh token step above for a test user and the account Id retrieved in the Accounts step above, make a call for transaction data. See: Akoya API v2 - Transactions reference.
Error cases	Code for Akoya API v2 errors. Develop UX for errors, timeouts, and reauthentication. See Errors.
Validate data	Validate use and display of data in your own systems and UI.

Need Help?

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.