Preparing to Integrate

Below is a list of suggested resources as you prepare to integrate with us. Ensure you’ve set up an account in the Data Recipient Hub. If your company has an existing account, ask a team member with admin access to add you). Go through the Getting started guide before reviewing the content below.

Planning

Prerequisites

• Please learn about Akoya’s offerings and technical requirements before starting development work.

Suggested learning path

• Read the products overview page in the docs to learn more about each of our offerings.

• Read the technical requirements for integration.

• Learn about the Data Recipient Hub and how to get started in our testing environment.

Development

Prerequisites

You should have:

• Created an account in the Data Recipient Hub.

• Configured a sandbox app.

• Completed the Getting started guide.

• Successfully retrieved data in our sandbox environment.

Suggested learning path

1. Review our Best practices guide.

2. Read about the Akoya consent flow.

   1. Introduction to OAuth 2

3. Check Data Recipient Hub documentation for provider nuances that may affect your app.

Most reference documentation is searchable by topic on our docs site. Some content, such as provider-specific nuances or troubleshooting guides, are available in the Data Recipient Hub. Check out the Data provider and Support center sections.

Integration guides

To help with integration, our Postman collections or OpenAPI specifications may help you get started.

The following resources may also help as you prepare to move your app into production:

• Headers

• Pagination

Guides available in the Data Recipient Hub Support Center

• Checking and savings transactions (nuances and enums)

• Data refresh types

Production access

Prerequisites

You should have:

• Completed testing in our sandbox

• Requested production access (from within the Data Recipient Hub).

Changelog