API integrations

Credentials for software that calls the Things5 API without a person.

An API integration is a set of credentials for software that calls the Things5 API on its own: a factory station, a server-to-server integration, a scheduled job. Use it instead of a person's username and password.

Open Admin › API integrations (organization administrators). Available if enabled for your organization.

API integrations

Create an integration

  1. New integration and give it a name (for example the station it is for).
  2. Copy the Client ID and the Client secret: the secret is shown only once. The dialog also shows the token address and an example request.
  3. Give it Permissions: the groups and the role on each. A new integration has no permissions.

The software then gets an access token valid for 5 minutes, see Get access token (API integration).

Manage

  • New secret creates a new secret; the old one stops working.
  • Revoke deletes the integration; software using it stops working immediately.

Create one integration per station or system, so you can revoke one without touching the others. Never put API credentials on a device: see Secure device provisioning.