Skip to main content

Sign In

Endpoint​

[POST] /auth/sign-in

Description​

This endpoint allows a user to sign in/login by providing the necessary details.

Request​

Headers​

KeyValueDescription
Content-Typeapplication/jsonSpecifies the request content type

Body Parameters​

ParameterTypeDescription
emailstringThe email of the user
passwordstringThe password of the user

Example Request​

{
    "email": "newuser@example.com",
    "password": "password123"
}

Response​

For see user resource, Check User Reference

Success (201 Created)​

{
  "message": "User created successfully",
  "data": {
    "user": { 
        //..
    },
    "accesstoken": "ey...."
  }
}

Error (400 Bad Request)​

{
  "message": "Invalid input data",
  "errors": [
    //...
  ]
}

Example Usage​

curl -X POST https://yourapi.com/auth/sign-up \
  -H "Content-Type: application/json" \
  -d '{
    "email": "newuser@example.com",
    "password": "password123"
    }'

References

User Reference​

User Resource


{
    "name": "Jhon",
    "lastname": "Doe",
    "email": "name@example.com",
}