The following section describes the technical steps to get started with the integration. It is an additional resource that completes our openAPI description of the REST API.
Web form services use Access (https://docs.finapi.io/#overview) in order to implement various workflows. The below steps are a pre-requisite to use Web form’s REST services. Essentially, it creates a secure profile for the customer and individual secure profiles for their end users necessary for consuming web form services.
finAPI follows the OAuth 2.0 Standard for authorizing applications and users within them. OAuth uses the terminology of clients and users. A client represents an application that calls finAPI services. A service call might be in the context of a user of the client (e.g: getting a user's bank connections), or outside any user context (e.g.: editing your client's configuration, or creating a new user for your client). In any case, every service call must be authorized by an access_token
. The documentation below describes how to set up client's users, or for the client itself.
Inc drawio | ||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
...
Code Block |
---|
{ "access_token": "fnsXpguIBkChhCsN8bVty9Y68AsUvJYyXUILcsFBvWABF03k8Ov68Ev2BTyANuBjyX8r9XuuTajNM2zZnhZMDjKWHN4lbRSRcVhg9_PcE7eeXHm0t28ZjzM4TJlrupZD", "token_type": "bearer", "expires_in": 3599, "scope": "all" } |
To get authorized as a Client, use the obtained access_token
as input for Access QUICK AUTH.
...
Code Block |
---|
{ "access_token": "nnsXpguIBkChhCsN8bVty9Y68AsUvJYyXUILcsFBvWABF03k8Ov68Ev2BTyANuBjyX8r9XuuTajNM2zZnhZMDjKWHN4lbRSRcVhg9_PcE7eeXHm0t28ZjzM4TJlrupZD", "token_type": "bearer", "expires_in": 3599, "scope": "all" } |
To get authorized as a User, use the obtained access_token
as an input for DI Web form QUICK AUTH (should be updated)
If you experience any problems during the integration or have any questions, please contact our support, support@finapi.io at any time. Our customer success team is looking forward to supporting you during your integration journey.
...