# Authentication
# CSRF Token
Before to start making requests to the Back-end it's important to request a CSRF token, which can be used to validate all subsequent requests to the API.
# Request
# Endpoint
https://invoices-backend.ampersand.dev/sanctum/csrf-cookie
# Method
POST
# Header
No parameters.
# Body
No parameters.
# Response
A XSRF-TOKEN=[...] cookie will be set to the current session:
# Login
In order to authenticate a user through the app, a Bearer token needs to be requested. All requests in the user's private dashboard needs to be authenticated using that token.
# Request
# Endpoint
https://invoices-backend.ampersand.dev/api/login
# Method
POST
# Header
No parameters.
# Body
emailpassworddevice_name
# Response
# Success
{
status_code: 200,
"access_token": "1|2uBPSzfXQqkoCQTJGruybL6F23y3V4itHziq1JBI",
"token_type": "Bearer"
}
# Error
{
status_code: 500,
message: [Error message] (string or array)
}
# Registration
To register a user into the database, this is the request that needs to be made.
# Request
# Endpoint
https://invoices-backend.ampersand.dev/api/register
# Method
POST
# Header
Content-Type: application/x-www-form-urlencoded
# Body
nameemailpassworddevice_name
# Response
# Success
{
status_code: 200,
"access_token": "1|2uBPSzfXQqkoCQTJGruybL6F23y3V4itHziq1JBI",
"token_type": "Bearer"
}
# Error
{
status_code: 500,
message: [Error message] (string or array)
}
# Logout
Endpoint to logout a user from the app and invalidate his session token.
# Request
# Endpoint
https://invoices-backend.ampersand.dev/api/logout
# Method
POST
# Header
Authorization: Bearer <token>
# Body
No parameters.
# Response
# Success
1
# Error
0
# Reset Password
Endpoint to reset user's password.
# Request
# Endpoint
https://invoices-backend.ampersand.dev/api/password/reset
# Method
POST
# Header
No parameters.
# Body
email
# Response
# Success
{
status_code: 200,
message: "A reset link has been sent to you by E-Mail."
}
# Error
{
status_code: 500,
message: [Error message] (string or array)
}