Authentication API

API Endpoint

All ShowClix APIs uses a simple token exchange authentication system where tokens are attached to users of the ShowClix Admin.

We recommend that you start by creating a new user underneath your partner or seller account. The permission you grant this user will determine what resources they can view/modify in the API. For this example let’s say your new user’s email and password are api@example.com and opensesame respectively. Tokens have a default TTL of 14 days so you may need to reauthenticate if a token expires.

After you generate a token as described below, for all future ShowClix API calls you will pass this token value to the API via the “X-API-Token” header for each of your API requests.

API Authentication Tokens

API Tokens

POST /api/registration
Requestsexample 1
Headers
Content-Type: application/x-www-form-urlencoded
Body
email=api@example.com&password=opensesame
Responses200
Headers
Content-Type: application/json
Body
{
  "token": "3e9fa1980a283fe902c83a8929d0ae91",
  "user_id": "12345678",
  "seller_id": "1234567",
  "name": {
    "first": "John",
    "last": "Doe"
  },
  "org": "Doe Tickets",
  "avatar": "",
  "locale": "en_US"
}

Create a New API Token
POST/api/registration

Request Attributes

Property Type Required Notes
email string always email of the ShowClix user that is authenticating
password string always password of the ShowClix user that is authenticating

Response Attributes

Property Type Notes
token string the token that should be used to authenticate API calls from here on out
user_id string id for the user that has authenticated
seller_id string id for the organization of the user
name object object with “first” and “last” names
org string name of the organization this user belongs to
avatar string url to avatar image for this user
locale string local in IETF language tag language code, e.g. en_US

Generated by aglio on 07 May 2024