API key

In addition to client credentials, the application also needs permission from the user to access the data and use the functionalities on his behalf. This permission is granted through the transfer of the API key. To generate an API key, the user must navigate to the Floriday Settings > Apps.

In here, they need to search for your application, click on it and finally click on the Add application button.

🚧

The API key is only shown once

The user needs to copy the API key and enter it in the application. For security reasons, the API key will only be shown once.

In case the user forgets to copy or loses the API key, they will need to remove and re-add the application in Floriday, in order to acquire a new API key.

📘

1 API key = 1 Organization ID = 1 GLN company code

1 API key authorizes the combination of 1 organization and 1 application.
1 organization corresponds to 1 GLN company code.

If an implementation requires access for more than one organization (e.g. sales agent for multiple supplier organizations), an API key needs to be generated for each separate organization.

You can copy the API-key into the application by logging into Floriday and selecting the desired application via settings, apps and links. The user can then add his application and copy the API-key into the Application.

It is possible for an user to deny access to an application at a later stage. This invalidates the API-key. If the user forgets the API-key or wants to add the application again he will have to generate a new API-key.

Using the API key and the JWT-token in combination, the APIs can be accessed in Floriday.

Identity check

The client application can check if the user inserted the correct API-key in the application by sending the API-key to Floriday Identity check. Floriday returns the Organization ID and Client ID of the API-key for validation by the client application.