Auth
Last updated
Last updated
Our API uses JSON Web Tokens (JWTs) for authentication. JWTs are a secure and efficient way to authenticate users.
To authenticate with our API, users must first create an account. Once they have created an account, they can generate a JWT by providing their username and password.
JWTs are signed with a secret key, which ensures that they are tamper-proof. They also contain an expiration date, which helps to prevent them from being used after they have expired.
To authenticate with our API, users must include their JWT in the Authorization header of their HTTP requests. The format of the Authorization header is as follows:
where <jwt>
is the JWT token.
Once the API has verified the JWT, it will grant the user access to the resources that they are authorized to access.
POST
{{BASE_URL}}/api/login
User authentication via email and password fields.
Name | Type | Description |
---|---|---|
POST
{{BASE_URL}}/api/register
User Registration. After registration you will need to confirm your email.
After registration, a confirmation email will be sent to the user.
GET
{{BASE_URL}}/api/verify-email/{token}
User confirmation via email.
After verification, a default team and a default project will be created for the client.
If the letter has not arrived in the post, you can use the endpoint below to resend it.
GET
{{BASE_URL}}/api/resend-email-verification
Request to resend the user's confirmation email to the user's email.
GET
{{BASE_URL}}/api/refresh
Update jwt tokens.
If a customer forgets their password, they can use the endpoint below. An email will then be sent to the user to recover the password.
POST
{{BASE_URL}}/api/forgot-passsword
Password recovery via email.
POST
{{BASE_URL}}/api/reset-passsword
Updates the password for the user.
Before registering a user, you can check if there is a user with that email address.
GET
{{BASE_URL}}/api/exist-email/{email}
Check if there is a user with the specified email address.
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
email*
String
password*
String
email*
String
password*
String
name*
String
token*
String
Bearer Token
capcha*
String
Authorization*
String
Bearer Token
Authorization*
String
Bearer Token
Authorization*
String
Bearer Token
email*
String
Authorization*
String
Bearer Token
token*
String
Bearer Token
newPassword*
String
email*
String