Postman Integration
To make your Yapily experience more bootstrapping, we provide Postman Collections. Note that this guide works best with the native Postman app. If you have any issues, try to update to the latest version of Postman. If problems persist, please get in touch with us via email or Slack.
-
Log in to the Yapily Dashboard and navigate to the "My Applications" section. Select your application, and click the "Download Postman Collection" button under the Tools section to generate a Postman Collection for your application.
Please take into consideration that you have to create an application with one or more institutions.
-
You can import this collection into your Postman installation.
-
Use Postman's global variables to automate issuing requests and make your requests more dynamic. You can access the global variables by clicking on your collection and then choose edit to view variable section. (right click will work too)
- Authorization information and application related information are pre-set as Postman variables.
- The institution-id, callback-url, consent-token, user-uuid and account-id variables should be specified by you.
- You can either alter the requests manually or specify those variables globally in the Postman Collection.
Retrieves a list with the users you have created for that application and the institutions they are connected to.
Create a user for your application by specifying the appUserId variable on the Json payload and setting a valid institution-id either by altering the Json payload or by setting the institution-id of your choice as a global variable.
Retrieves the user that you have created for the user-uuid specified.
Requirements
- Specify a valid user-uuid.
In order to retrieve information on your institution account you have to provide your consent through the institution authentication process. Open the Postman console (CMD/CTRL + ALT + C) in order to retrieve the url that you have to navigate to. Once the url is printed, copy it into your browser in order to initiate the authorisation process with the institution of your choice. By the end of the authorization a consent-token will be present as a parameter to the callback.
Requirements
- Specify a valid institution-id which exists in your application
- Specify a valid user-uuid which is connected with the institution specified.
Hints
- In order to retrieve a valid user-uuid use the 'Get User' request or just create a new User using 'Create application user'.
You can retrieve the list of consents for a specific user of your application.
Requirements
- Specify a valid user-uuid.
You can retrieve the list of user-consents for a specific institution.
Requirements
- Specify a valid user-uuid.
- Specify a valid institution-id
Some institutions are providing their users directly with an application key that they have to add on our API in order to retrieve account information. Add a user consent by specifying the api-key and the institution-id variables on the Json payload.
Requirements
- Specify a valid user-uuid.
- Specify a valid institution-id
- Specify a valid api-key for the institution on the Json payload.
Delete a consent that the user has issued.
Requirements
- Specify a valid user-uuid.
- Specify a valid consent-token
Hint
You can retrieve a valid consent-token by using the 'Get User Consents' request.
Retrieves the institution specified.
Requirements
- Specify a valid institution-id.
Retrieves a list of the institutions your application is integrated with.
Get the identity related to the user that has been previously authorised on the selected institution.
Requirements
- Specify a valid consent-token which exists in your application on the request header
Hints
- You can retrieve a valid consent-token by using the 'Get User Consents' request.
- You can retrieve a valid consent-token for the institution of your choice by using the 'Get User Consents for Institution' request.
Get the accounts related to the user that has been previously authorised on an institution.
Requirements
- Specify a valid consent-token which exists in your application on the request header
Hints
- You can retrieve a valid consent-token by using the 'Get User Consents' request.
- You can retrieve a valid consent-token for the institution of your choice by using the 'Get User Consents for Institution' request.
Get an account info related to the user that has been previously authorised on an institution and the selected account.
Requirements
- Specify a valid consent-token which exists in your application on the request header
- Specify a valid account-id based on the institution specified.
Hints
- You can retrieve a valid consent-token by using the 'Get User Consents' request.
- You can retrieve a valid consent-token for the institution of your choice by using the 'Get User Consents for Institution' request.
Get the transactions related to the user that has been previously authorised on an institution and the selected account.
Requirements
- Specify a valid consent-token which exists in your application on the request header
- Specify a valid account-id based on the institution specified.
Hints
- You can retrieve a valid consent-token by using the 'Get User Consents' request.
- You can retrieve a valid consent-token for the institution of your choice by using the 'Get User Consents for Institution' request.