Currently we are in a phase of providing new APIs which are identified by v4
and can be found on getflip.dev. We still support our old APIs and will inform you in time in advance you when they will be retired eventually.
Application Programming Interfaces or short APIs are used by applications to communicate with each other. To access resources via an API the requesting application must authenticate itself as an API client.
You can create and manage API clients in the Admin Console > Access & security > API clients.
Only new API clients appear in the table. Previously created API clients are not shown, and managed by our Customer Success Engineering team. Please contact them for changes.
After creation, an API client appears and behaves just like a normal user in the system. The username will be service-account-<client_id>
.
Create an API client
- Open the Admin Console and navigate to Access & security > API clients.
- Click the button “Add API Client” in the upper right corner.
- Enter the “Client ID”. This will be a fixed value and cannot be changed afterward.
- By selecting the “Role” you can set the authorization of this API client. “Legacy Roles” are for our old APIs. The authorization roles can be changed afterward.
- Enter the first- and last-name as each API client will appear in the app as a user. You can change the names afterward.
- Click “Create API client”.
- ⚠️ Copy the Client secret from the API client detail page which opened up. The client secret will not be shown again.
Edit an API client
Despite appearing like a normal user, API clients can only be edited in the Access & security > API clients in the Admin Console and not in User management.
- Click on the API client you want to edit.
- In the detail view click “Edit”.
- You can edit the description, roles and profile information.
- Click “Save changes”.
Deactivate and re-activate API clients
In the detail view of the API client you want to deactivate, click “Deactivate API client”.
This prevents applications from obtaining new access tokens and therefore blocks access to our system. This might break existing integrations.
To re-activate an API client, click “Activate API client”.
Delete an API Client
In the detail view of the API client you want to delete, click “Delete API client”.
⚠️ Deleting this API client will permanently remove it from the system and is not reversible. Any applications relying on this client will no longer be able to obtain access tokens and may experience integration issues.
Comments
0 comments
Please sign in to leave a comment.