Explo's Authentication

Explo utilizes token based authentication. To correctly make a call to an API, it must include the Explo-Authorization header with a valid team token. Below is an example of what the header would look like, replacing <team_token> with a valid token.

'Explo-Authorization': 'Token <team_token>'

End User Group APIs

Get or Create New User Group

This endpoint gets or creates a new user group. If the user_group_id does not exist, a new user group will be created and information about the group will be sent back. If the user_group_id exists, no action will be taken but the same information about the group will be sent back. There will be a flag in the response indicating if a new user group was created.

Endpoint:

POST https://embeddo.herokuapp.com/embed/create_user_group/

Body:

{
		"user_group_id": "example_1",
    "name": "Example 1"
}

• user_group_id
  • STRING
  • This is the ID you use to identify this user group in your databases.
• name
  • STRING
  • This is the name of the user group.

Response:

{
    "success": 1,
    "new_user_group": true,
    "user_group": {
        "team_id": 3,
        "token": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
        "name": "Example 1",
        "provided_id": "example_1"
    }
}

• success
  • Indicates whether the call was successful.
• new_user_group
  • Indicates whether a new user group was created.
• team_id
  • This is Explo's internal ID for this user group. You don't need to record this information, since you will not need to use it.
• token
  • This is the user group token (userGroupToken or USER_GROUP_TOKEN) that will be used to identify which user group is viewing the dashboard
• name
  • This is the name provided in the request body.