Login

This endpoint allows you to perform a user login process. If the login is successful, the system returns you the Bearer Token that you need to use for access. With this token you can access all other endpoints that require authentication.

Parameters

ParameterTypeDescription
usernameRequiredLogin email adress
passwordRequiredLogin email password

Users with management panel authorization can log in with their email and password. This can be provided by the relevant company employee/authorized person.

{
     "email": "johndoe@altium.net",
     "password": "password123"
}

Generating Token

Endpoint URL

POST
https://altium.net/api/login

Parameters

  • Name
    email
    Format
    string
    Description

    Altium admin email adress

  • Name
    password
    Format
    string
    Description

    Your password

Description

After logging in to the API, you should use the token value returned to you as a Bearer Token when making requests to other endpoints.

Each time you log in, a new token will be generated and the old one will become invalid.

   Authorization: Bearer <token>

Sample Request Body

POST
https://altium.net/api/login
{
    "email": "johndoe@altium.net",
    "password": "password"
}

Örnek Response

{
    "message": "Successfully logged in",
    "token": "21|mCxdrdsaafa6gzXpxzA40w5gW5UPz8fldb854ce7"
}

Did this document help you?