Developer project checklist

An overview of technical implementation steps to integrate with the Akoya Data Access Network.

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

Authenticate & select accounts

TaskDescription
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 secretEvery App has a unique client Id and secret. They must be treated as secure information and stored securely.
UX - Provider popup or redirectIntegrate into your existing provider selection UI or build popup/ redirect flow for the end-user to select the data provider(s) they'd like to connect with your app. Upon end-user selection, initiate consent and authentication via Akoya to the provider. See: OAuth implementation styles.
Use Sandbox data for implementation and testingThe 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 GrantAfter authentication and authorization, Akoya will return the end-user 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 end-user. See: Authorization Code.
Store x-akoya-interaction-idAkoya returns an interaction id in every response header. Retain the id with logs for support and error tracking.
Id and refresh token generationExchange authorization code for ID and Refresh Token See: Token API reference and the token explainer.
Store TokenUse your current secure token storage or implement a way to store each end-user's unique tokens.
Token RevocationImplement a way for the end-user to remove access to their data provider account(s). See Revoke Token.
Error CasesCode for Authorization or Token errors. Develop UX for errors, timeouts, and reauthentication. See Authentication errors and Token API errors.
Validate authenticationValidate UX for account selection, consent, ID/Refresh Token for new and existing users.

Obtain data

TaskDescription
Store x-akoya-interaction-idAkoya returns an interaction id in every response header. Retain the id with logs for support and error tracking.
AccountsUsing 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 reference.
TransactionsUsing 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 CasesCode for Akoya API v2 errors. Develop UX for errors, timeouts, and reauthentication. See Errors.
Validate DataValidate use and display of data in your own systems and UI.