Public
Documentation Settings
Prod: BlackJax
Double Column
cURL - cURL
BlackJax
Introduction
Authentication
users

BlackJax

RESTful API for the BlackJax website.

HTTPS required.

Authentication

JWT will be stored in the cookies for user authentication

POSTSignup

https://blackjax-backend.herokuapp.com/api/v1/users/signup

This method allows a user to sign up through the application with an email and password.

Example Request
Signup
curl
curl --location --request POST 'https://blackjax-backend.herokuapp.com/api/v1/users/signup'
Example Response
No response body
This request doesn't return any response body
No response headers
This request doesn't return any response headers

POSTLogin

https://blackjax-backend.herokuapp.com/api/v1/users/login

This method allows a user to log in through the application with an email and password.

Bodyraw (json)
json
{
    "email": "user@gmail.com",
    "password": "password1234"
}
Example Request
Login
curl
curl --location 'https://blackjax-backend.herokuapp.com/api/v1/users/login' \
--data-raw '{
    "email": "user@gmail.com",
    "password": "password1234"
}'
Example Response
No response body
This request doesn't return any response body
No response headers
This request doesn't return any response headers

POSTForgot Password

https://blackjax-backend.herokuapp.com/api/v1/users/forgotPassword

User's may request to reset a password using their email. And email will be sent to them with a link where they can reset their password.

Bodyraw (json)
json
{
    "email": "user@gmail.com"
}
Example Request
Forgot Password
curl
curl --location 'https://blackjax-backend.herokuapp.com/api/v1/users/forgotPassword' \
--data-raw '{
    "email": "user@gmail.com"
}'
Example Response
No response body
This request doesn't return any response body
No response headers
This request doesn't return any response headers

GETLogout

https://blackjax-backend.herokuapp.com/api/v1/users/logout

Simply deletes the user's cookie

Example Request
Logout
curl
curl --location 'https://blackjax-backend.herokuapp.com/api/v1/users/logout'
Example Response
No response body
This request doesn't return any response body
No response headers
This request doesn't return any response headers