Skip to content

Websocket collector authentication

Before you can send data to Tallyfy Manufactory via a websocket, you’ll need to authenticate the client/end-user.

You can authenticate users using the endpoint POST /auth.

Required header:

  • X-Manufactory-Auth - Project key of the project to be populated.

Required keys

  • org_id (required) string - Manufactory org ID.
  • project_id (required) number - The project ID associated with this schema.
  • actor_profile (required) object - Key-value pairs with the correct attribute names and data types. See Get Actors schema.

Request example

{
"org_id": "xyz",
"project_id": 12345,
"actor_profile":{
"city": "New York",
"country": "USA",
"username": "john.doe",
"email": "john.doe@email.com"
}
}

Response example

{
"org_id": "xyz",
"project_id": 12345,
"actor_profile_id": 1,
"client_uuid": "dcd21714-894c-46bc-9d59-ae9f22753205"
}

The generated client UUID1 is limited to this specific user profile, and it’s valid for a 12-hour session2. After 12 hours, you’ll need to re-authenticate the client.

Footnotes

  1. Universally Unique Identifier - a standardized 128-bit format for session tracking

  2. Session expires at exactly 12 hours from generation, not based on activity