MAXIMUS API

What is Maximus API?

Maximus API provides authentication, authorization for your web apps. Your users can sign in directly with a username and password.

There is a user data pull for authorized users. You as a developer can manage the user's data in your web application (use username, email, id, created_at and updated_at for your purposes).

User authorization through Maximus API based on API authentication using a random token assigned to each user of your application.

Getting started with Maximus API?

The Maximus API provides endpoint URLs for registration, authorization, email verification, password reset.

Due to user authorization, after successful authentication, the server response contains a token. This token must be saved by your application and used for each future request as the "Bearer Token".

The front-end part is fully under developer's responsibility, however you can use prebuilt starter kit for Vue.js 3 Single Page Application (SPA) - Maximus SPA (more details you can find here https://github.com/Maxim-us/Maximus-SPA).

There are several API URLs you should know about:

Registration:

POST: https://api.markomaksym.com.ua/api/register

For user registration, you must use an unauthorized POST request with the following parameters:

name
email
password
password_confirmation

Login:

POST: https://api.markomaksym.com.ua/api/login

For user login, you must use an unauthorized POST request with the following parameters:

email
password
remember

Sign out:

POST: https://api.markomaksym.com.ua/api/logout

For sign out user, you must use an authorized POST request without any parameters.

Email Verification (send url):

POST: https://api.markomaksym.com.ua/api/send-email-verification-url

To send email verification URL to user's email address, you must use an authorized POST request with following:

verificationUrl

"verificationUrl" is an Base url of a page where user will be redirected from his/her email address (eg. http://domain.com/verify-email-check).

Email Verification (check url):

POST: https://api.markomaksym.com.ua/api/send-email-verification-check

To check email verification URL from user's email address, you can use an unauthorized or an authorized POST request with following parameters:

id
hash

"id" is an id of the current user. "hash" is an automatically generated string from email verification URL (eg. http://domain.com/verify-email-check?id=24&hash=d1D/2aMqY5AVUNjRsaqsK.W56oYS5ltgnJUod3IgJVjKcfxBkJXPu).

Forgot password:

POST: https://api.markomaksym.com.ua/api/forgot-password

To send forgot password URL to user's email address, you must use an authorized POST request with following parameters:

email
resetPasswordUrl

"email" is an email of the current user. "resetPasswordUrl" is an Base url of a page where user will be redirected from his/her email address (eg. http://domain.com/reset-password).

Reset password:

POST: https://api.markomaksym.com.ua/api/reset-password

To reset password you must handle reset password URL from user's email address, using an authorized POST request with following parameters:

email
password
password_confirmation
token

"token" is an automatically generated string in URL (eg. http://domain.com/reset-password?token=y10$oGbE99vXTLTeTC.k7QVgiOFvtmB1dLY4dXRnteLgTzRKNKYjfLQWS).

Get User Data:

GET: https://api.markomaksym.com.ua/api/user

To get user's data you must use an authorized GET request with Bearer Token generated after successful login request.

Maksym-Marko/Maximus-API