Postman Collection
Consider using Postman for testing. Visit the Postman Akoya workspace for the collections and environment (default values for use in sandbox). See the parameters in the Environment Parameters chart.
Installing and Configuring the Postman App
The Postman app is available for the Mac, Windows, and Linux operating systems. For more information, see Installing and updating Postman.
You may need to change some app defaults depending on your personal preferences or company network environment. Refer to Setting up Postman for a detailed explanation of Postman settings.
Working with Akoya's Postman Collection
Edit access to the collection is restricted. You may:
Export the collection to JSON
Create a fork in your own personal workspace
Environment
Once youâve imported/forked your own local copy of the collection, fork a local copy of the Environments from the collection. You can find some of the variable values for your account on the My apps page of the Data Recipient Hub. Click the âEnvironmentsâ tab to update the variables to your specific values.
Environment Parameters
Parameter | Description |
|---|---|
accountId | Your applicationâs client id from Akoya. Akoya issues client ID/secret combinations for each app in each environment. More details on the client credentials specification: https://tools.ietf.org/html/rfc6749#section-3.2.1 sandbox: your sandbox app id prod: Akoya provides a production client ID/secret combo for each recipient app. |
client_id | Your applicationâs client id from Akoya. Akoya issues client ID/secret combinations for each app in each environment. More details on the client credentials specification: https://tools.ietf.org/html/rfc6749#section-3.2.1 sandbox: your sandbox app id prod: Akoya provides a production client ID/secret combo for each recipient app. |
client_secret | Your appâs client secret |
connector | The Akoya identifier for the data provider your user logs in to. Usually the same as providerId. Akoya takes this identifier and directs the user through the appropriate provider's login flow. sandbox: mikomo prod: provider ids are available after onboarding |
id_token | The data APIs use the id token as a bearer token with all data requests. It's a short-lived token which you must refresh on a periodic basis. |
idp_url | The URL for the identity provider service used in the authentication and authorization flow. sandbox: (Mikomo) sandbox-idp.ddp.akoya.com production: idp.ddp.akoya.com |
links_prev | Stored value for paging transactions to previous page. |
links_next | Stored value for paging transactions to next page. |
permission_url | URL for the âRevoke tokenâ endpoint sandbox: sandbox-permission.api.ddp.akoya.com production: permission.api.ddp.akoya.com |
products_url | The URL for Akoya products. sandbox: sandbox-products.ddp.akoya.com |
providerId | The id of the data provider of the account permissioned by the consumer sandbox: mikomo |
redirect_uri | You must register the redirect URI with Akoya for the appropriate client id. Akoya validates that the redirect URI exactly matches the one registered to prevent malicious redirects. The redirect URI specifies where the system sends the consumer after authentication. More details on redirection: https://tools.ietf.org/html/rfc6749#section-3.1.2 |
refresh_token | Use a refresh token to obtain a new ID token without requiring the consumer to provide credentials or reauthenticate every time the ID token expires. The refresh token is longer-lived and is only used for maintaining the ID token, not as a token for requesting data. |
version | The version of the Akoya product APIs |
statementId | The long-term persistent identity of the statement |
Definitions
Parameter | Endpoint(s) | Method(s) | Description |
|---|---|---|---|
code | token | GET | Authorization code received in the redirect after authorization. More details on specification: |
grant_type | token, refresh_token | POST | Depends on the request (i.e. access token request, refresh token request, client credentials request) token: authorization_code refresh: refresh_token An authorization grant is a credential representing the resource owner's authorization used by the client to obtain an access token. More details on authorization: |
Tips & Tricks
You may also test against Postman mock servers by following the instructions provided in this document.
By default, the Postman app uses your operating system's configured proxy to send API requests or access the internet. If needed, you can enter authentication details for the default proxy in the Postman app. You can also configure Postman to use the system proxy or a custom proxy when sending requests. See Postman's "Getting Started" guide for more info.
Testing Endpoints with Postman
Akoya provides secure (TLS v1.2) access to RESTful APIs that are based on the API/Data Structures as defined by the Financial Data Exchange. All data requests use standard GET and POST methods and must include a bearer token in the authorization header. Our endpoints return all responses in JSON format.
Consumer Authentication
Consumers must authenticate with their data providers before you can get their data.
Your application sends users to their providerâs login page via the Akoya platform.
After successful authentication, the provider presents users with an authorization page requesting permission to share their data with your app.
If you're granted permission, your application is issued two tokens (id and refresh) from Akoya which give you permissioned access to consumer data.
If consumers do not grant permission to share data, Akoya sends them back to your application (to the page of your choosing).
See the âGetting Startedâ page in the API docs for instructions on setting up a Hub account and getting ready to test the APIs.
See the Mikomo Test Users document for information on available test accounts. In the sandbox environment, the providerId will always be mikomo.