When should I use this guide?
Use this guide when an external system will connect to Infobric Machines through Integration API and needs a client ID and client secret.
This guide explains how to:
create an API client
save the client's credentials
change the client's name
generate a new client secret
delete an API client
Prerequisites
You need to:
have the Owner or Administrator role
have access to Infobric Machines on the web
know which external system will use the API client
The User role does not have access to Client management.
Create an API client
Sign in to Infobric Machines.
Open Administration.
Select Client management.
Select Create client.
Enter a clear name under Client name.
Select Create client.
Copy the Client ID and Client secret, and store them securely.
When the credentials have been saved, select I have saved the client secret, close this dialog.
⚠️ Save the client secret before closing the dialog. It is shown only once. If it is lost, you need to generate a new secret.
Share the client ID and client secret with the person or system responsible for the API integration using a secure transfer method.
View and edit API clients
Existing clients are listed under Client management. The list includes:
Client ID
Number of requests
Name
Password changed
available Actions
To change the client name:
Open the client in the list.
Change the Client name.
Select Edit client.
The client ID is locked and cannot be changed.
Generate a new client secret
Generate a new secret if the previous one has been lost, may have been exposed or needs to be replaced.
Find the client under Client management.
Select Generate new secret.
Read the warning in the Confirm secret regeneration dialog.
Select Yes, regenerate.
Copy the new client secret and store it securely before closing the dialog.
Update the external system with the new secret.
When a new secret is generated, existing API integrations may stop working until their credentials have been updated.
Delete an API client
Only delete a client when the external system should no longer have access to Machines.
Open the client under Client management.
Select Delete client.
Read the warning and confirm the deletion.
⚠️ Deletion cannot be undone. After the client has been deleted, external systems can no longer use it to retrieve information from Machines.
Open the API documentation
Select API Documentation on the Client management page to open the documentation for Integration API v1.
The documentation provides information for integration developers, including authentication and API areas for machines, places and usage.
If it does not work
First, check that:
you have the Owner or Administrator role
the client name has been entered when creating the client
the client ID and client secret have been copied correctly
the external system is using the most recently generated client secret
the client has not been deleted
A lost client secret cannot be displayed again. Generate a new secret and then update the external system.
If an integration stops working after a secret has been regenerated, check that the external system has been updated with the new secret.
Tips
Use a client name that clearly identifies the system or integration.
Create separate clients for different external systems so that access can be managed independently.
Never store client secrets in screenshots, ordinary email messages or public documents.
Delete a client when the integration is no longer used.