You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 7 Next »

Client overview


To make it easier to get started with integrations, the client overview is now available to administrators.

This will give you the freedom to grant access for developers to your feed API so they can integrate with feed. 
 
 
 
 

Here you can now create and maintain API clients. The fields that can be filled out:

  • Id\*: The identifier for the API user

  • Client Secret\*: The key used together with the identifier to authenticate the API user

  • Token expiration time\*: Time in seconds for how long the OAuth2 refresh token should be valid

  • Authorities\*: The roles determine the access the API user should have. For example, if the API user only needs to extract data from the feed, they will only need export. If the user also needs to import, import can also be checked.

  • Description: Here you can enter a description for the API user, such as who will use it or for what purpose.


When the access has been created, the recipient must receive this information along with other important information so that they can start reviewing the documentation and obtain the access token.


Here is a suggested text that can be sent to the user: 

---------------------------------------------------------------------------------------------------------

Hello and welcome as a user of the FEED API.

To get started with integration, you can read the API documentation at:

https://<hostname>/export/swagger-ui/

https://<hostname>/media/swagger-ui/


To use the API, you need to use Oauth 2.0 to obtain an access token.

Client ID: Enter feed client ID

Client secret: Enter feed client key


Grant type:
Client Credentials with Basic Auth Header


Token server:
https://<hostname>/token-server/oauth/token

The Auth header is set in the API call using the access token from the token server:

Authorization: Bearer <access-token>


Token timeout: 36000 seconds

---------------------------------------------------------------------------------------------------------

  • No labels