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

Authentication for a websocket connection requires pairing with client/end-user through an auth message containing org ID project ID actor profile ID and client UUID before enabling event transmission.

Collector > Collecting events via websocket

A comprehensive system enables real-time data collection through multiple integration methods including REST API websocket and CLI agent while providing secure authentication and data viewing capabilities.

Actors > Create actors schema

The POST /actors/schema endpoint allows creation of actor schemas by specifying organization ID project ID attributes and a unique identifier with proper authentication through a Manufactory access token.

Agent > Authentication for the agent collector

Authentication setup for Manufactory requires configuring a YAML file with organization ID project ID and project key values which must be in the same directory as the manufactory-agent.