curl --request POST \
  --url https://api.hyrd.de/v1/login \
  --header 'Content-Type: application/json' \
  --data '
{
  "user": {
    "login": "[email protected]",
    "password": "yourpassword123"
  }
}
'

{
  "error": "Invalid Login or password."
}

Users

Login

Login API Documentation

API Overview

Name: Login API
Description: This API endpoint allows users to log in by providing their credentials (username/email and password).
Method: POST
Endpoint URL: /v1/login

Authentication

No authentication is required to access this endpoint, as this is the login process.

Request

HTTP Method:

POST

URL:

/v1/login

Headers:

Header Name	Description	Required	Example
`Content-Type`	The content type of the request	Yes	`application/json`
`Accept`	Expected response format	No	`application/json`

Request Body:

The request body should be sent in JSON format with the following parameters:

Field Name	Data Type	Description	Required	Example
`email`	`string`	The email of the user	Yes	`"[email protected]"`
`password`	`string`	The password of the user	Yes	`"yourpassword123"`

Responses

Success Response:

Status Code: 200 OK
Message: Success
Data: User object

POST

curl --request POST \
  --url https://api.hyrd.de/v1/login \
  --header 'Content-Type: application/json' \
  --data '
{
  "user": {
    "login": "[email protected]",
    "password": "yourpassword123"
  }
}
'

{
  "error": "Invalid Login or password."
}

Headers

Content-Type

string

Body

application/json

The body is of type object.

Response

401 - application/json

Unauthorized

The response is of type object.

Introduction Log out

⌘I

API Documentation