NexTwin Public Twin API

Reference documentation for the public endpoints exposed under /ps/twins/public by twin-service (twin/routes.go PublicRouter).

A valid API key is required to access these endpoints. By default they return each twin's public fields; an API key request may also ask for the fields restricted to a specific role. See Authentication and roles for how to authenticate and how that choice affects which fields you receive.

See Public Twin in the sidebar for the endpoint reference.

Creating an API key

In order to create an API key and interact with the endpoints, you must have admin access to the NexTwin platform.

When logged in, go to Administration -> API Keys and click on + New API Key. In here you can set a description for the key to describe its use-case, and optionally set an expiration date. Make sure to save the key in a safe location, as it can only be viewed once. If you lose access to the key, you can create a new key.