Skip to content
Cookbook
/REST/
/
Login

Login

Goal

Log in and get your access token.

Prerequisites

  • Your REST API app.
  • User ID, password, and organization ID from Integral.
  • Login URL.

Steps

Step 1: Call endpoint
Step 2: Get token
Step 3: Include token in API calls

Step 1: Login

Use the Login and get token endpoint.

application/json
{
  "user": "apiUserId",
  "pass": "This is a long password!",
  "org": "apiOrganizationId"
}

Step 2: Get token

Your access token is in SSO_TOKEN of the response header. Your token is valid for limited time.

Response header example:

[
  ...
  {
    "key": "Set-Cookie",
    "value": "SSO_TOKEN=hidH61Uy63IYT08avDFEUUrEO_Sn-BZ6yEqyON5SJS_h0gU8vOaNItVGllwHTH; Domain=.integral.com; Path=/",
    "description": "Sends cookies from the server to the user agent.",
    "enabled": true,
    "disableEdit": true,
    "info": "Sends cookies from the server to the user agent."
  },
  {
    "key": "Set-Cookie",
    "value": "SSO_TOKEN=hidH61Uy63IYT08avDFEUUrEO_Sn-BZ6yEqyON5SJS_h0gU8vOaNItVGllwHTH; Path=/",
    "description": "Sends cookies from the server to the user agent.",
    "enabled": true,
    "disableEdit": true,
    "info": "Sends cookies from the server to the user agent."
  },
  ...
]

Step 3: Put your token in all request headers

Pass the SSO_TOKEN cookie value with all of your subsequent API requests.

Previous page
Next page