Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The following section describes the technical steps to get started with the integration. It is an additional resource which that completes our openAPI description of the REST API.

Web form services use Access () in order to implement various workflows. The below steps is 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.

...

To get authorized as a client, make a call to Access POST/oauth/ tokentokenand pass the following request parameters:

  • grant_type=client_credentials

  • client_id

  • client_secret

The client authorization request response:

...

To get authorized, use the obtained access_token as an input for Access QUICK AUTH.

...

The major prerequisite for creating a user is getting authorized as a client with the help of the obtained access_token in Step 1.

To create a user, make a call to Access POST/users and pass the following request body:

Code Block
{
  "id": "username",
  "password": "password",
  "email": "email@localhost.de",
  "phone": "+49 99 999999-999",
  "isAutoUpdateEnabled": false
}

The user creation request response:

Code Block
{
  "id": "username",
  "password": "password",
  "email": "email@localhost.de",
  "phone": "+49 99 999999-999",
  "isAutoUpdateEnabled": false
}

Step 3: Get authorized as a user

The major prerequisite for creating a user is getting the user’s data, such as password and id (username) from the Step 2.

To get authorized as a user, make a call to Access POST/oauth/tokenand pass the following request parameters:

  • grant_type=password

  • client_id

  • username

  • password

...

Code Block
{
  "access_token": "nnsXpguIBkChhCsN8bVty9Y68AsUvJYyXUILcsFBvWABF03k8Ov68Ev2BTyANuBjyX8r9XuuTajNM2zZnhZMDjKWHN4lbRSRcVhg9_PcE7eeXHm0t28ZjzM4TJlrupZD",
  "token_type": "bearer",
  "expires_in": 3599,
  "scope": "all"
}

To get authorized, use the obtained access_token as an input for DI QUICK AUTH (warning) (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.

...