Welcome to unifinu's doc center
-
General
-
Reporting API
-
Connectors API
-
Accounts API
-
Dashboard
-
FAQ
-
Legal
-
Users API
Context
In order to use any of the API models, you need to create a JWT/Bearer token first. Once the token is created, you need to include it in any other API call when communicating with the APP.
SSL Security requirements
Connecting to the APP via API needs to via secured channels. We follow the industry standards as much as possible. However, if we could deviate from that if needed.
Please find supported versions below;
Type
|
Supported?
|
---|---|
SSL 2.0
|
Blocked
|
SSL 3.0
|
Blocked
|
TLS 1.0
|
Blocked
|
TLS 1.1
|
Blocked
|
TLS 1.2
|
Accepted
|
TLS 1.3
|
Accepted
|
Header information
The unifinu APP requires you for the minimum header information. If these fields are not sent, errors like ‘415’ or ‘400’ can occur. The following fields and respective values need to be included.
Type
|
Value
|
---|---|
Content-Type
|
application/json
|
Host
|
-
|
Content-Length
|
-
|
Authentication Request
The first step is to create a JWT/Bearer token. For this you need to POST authentication details to our ‘authenticate’ endpoint.
The username and password are the same as the user who has manual acces, or as the API specific user. In return we will provide you with the JWT token.
POST http://unifinu.eu-central-1.elasticbeanstalk.com/unifinu/authenticate
{
"username": "string",
"password": "string"
}
Authentication Response
Once the authentication request was successfully processed , a JWT/Bearer token will be returned.
The token is valid for a limited time for security purposes.
{
"jwt": "eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhbm5lLmRhbXN0cmFAdW5pZmludS5jb20iLCJQZXJtaXNzaW9ucyI6eyIxIjpbIlJPTEVTX0FDQ0VTUyIsIk1BTkFHRV9ST0xFUyIsIlNFQVJDSCIsIk1BTkFHRV9NRVJDSEFOVFMiLCJNQVBfVVNFUl9NRVJDSEFOVCIsIk1FUkNIQU5UU19BQ0NFU1MiLCJVUExPQURfQUNDRVNTIiwiREFTSEJPQVJEX0FDQ0VTUyIsIk1BTkFHRV9VU0VSUyIsIlVTRVJTX0FDQ0VTUyIsIk1BUF9VU0VSX1JPTEVTIl0sIjIiOlsiU1VQUkVNRV9BRE1JTklTVFJBVE9SIiwiRklMRV9ET1dOTE9BRCJdfSwiZXhwIjoxNjc2MTE0NzQ2LCJpYXQiOjE2NzYxMTI5NDZ9.2BgMG9gP_Ie2PsZTRAkJlOclyQ3dtLG5QjQOoDPYx-w"
}
Response codes
Depending on the request or status of the user / account, different codes can be generated.
Ultimately code ‘200’ is what you’re looking for.
Code
|
Description
|
---|---|
200
|
OK
|
201
|
Created
|
401
|
Unauthorized
|
403
|
Forbidden
|
404
|
Not Found
|
API Explorer section
More information can be found here.