Skip to content

Authentication for the web socket collector

Before you can start sending data to Manufactory via a web socket, 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 UUID is limited to this specific user profile, and it’s valid for a 12 hours session. After 12 hours, you would need to re-authenticate the client.

Websocket > Connect to our Web Socket Server

Connect to the websocket server with authentication credentials and pair the connection using actor profile ID and client UUID to establish a secure communication channel for sending actor-generated events.

Actors > Create actors schema

The POST /actors/schema endpoint enables creation of user profiles by specifying organization details project ID unique identifiers and data attributes requiring authentication through a Manufactory access token.

Agent > Authentication for the agent collector

The configuration file requires an organization ID project ID and project key values for authentication with the Manufactory system while ensuring both files are in the same directory.

Actors > Get actors schema

The GET endpoint retrieves actor schema details by organization and project IDs returning attribute definitions with data types and unique identifiers through an authenticated request.
Get in touch
About Tallyfy