login

POST

/api/v1/users/login

Last modified:2024-08-26 07:36:49

The Login Service allows users to authenticate and obtain a JWT token to make subsequent API calls. For details, refer to the Authentication documentation.

Request

Header Params

Body Params application/json

Example

{
    "companyId": "{{COMPANY_ID}}",
    "siteId": {{SITE_ID}},
    "username": "{{USERNAME}}",
    "password": "{{PASSWORD}}"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/api/v1/users/login' \
--header 'Content-Type: application/json' \
--data-raw '{
    "companyId": "{{COMPANY_ID}}",
    "siteId": {{SITE_ID}},
    "username": "{{USERNAME}}",
    "password": "{{PASSWORD}}"
}'

Responses

🟢200Success

application/json

Body

Example

{
    "username": "API_USER",
    "companyId": "TENAN",
    "siteId": 501,
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6IkFQSV9URVNUIiwiY29tcGFueUlkIjoiU1ZJTDMiLCJzaXRlSWQiOiI1MDEiLCJyb2xlcyI6IkFQSV9BTEwiLCJpYXQiOjE3MTUyMzcwNzQsImV4cCI6MTcxNTIzNzM3NH0.JWQCmyGxY6fX7kAxXcRhxrxpuHigeEltXlEiZl7tL-k",
    "expires": "2024-05-09T06:49:19.050Z",
    "expiresInMS": 285000
}

🟠422Unique constraint error

Modified at 2024-08-26 07:36:49

Product