Skip to content

Authentication for the web socket collector

Before you can start sending data to Tallyfy Manufactory via a websocket, you 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 - Pairs containing attribute name and the corresponding value while considering the correct attribute names and data types. Please refer to 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 hours session2. After 12 hours, you would need to re-authenticate the client.

Websocket > Connect to our web socket server

Tallyfy Manufactory websocket authentication requires establishing a connection to wss://collector.tallyfy.com/ws then sending an auth message with five required keys (type org_id project_id client_uuid actor_profile_id) to pair the connection with the authenticated client before events can be transmitted.

Agent > Authentication for the agent collector

To authenticate with Tallyfy Manufactory you must configure a YAML file containing your organization ID project ID and project key values which should be placed in the same directory as the manufactory-agent executable.

Actors > Create actors schema

The POST /actors/schema endpoint enables creation of user schemas in Tallyfy Manufactory by specifying organization ID project ID attribute definitions and a unique identifier field with proper authentication headers.

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 ↩

Get in touch
About Tallyfy