OPJU-Developers-Community / opju-exam-portal-fe-admin

Admin Portal - Seamless Access for Administrators
https://uat-opju-admin.netlify.app/
3 stars 2 forks source link

docs: admin authentication api request #16

Open subrat611 opened 10 months ago

subrat611 commented 10 months ago

Documentation description

Need admin auth POST and GET API endpoint with proper documentation.

Tanusingh02 commented 10 months ago

Here is the required API - POST- signup

BASE_URL = /api/v1/admin
POST {BASE_URL }/signup

params 
 none

payload 
{string} name 
{string} email
{string} password

Example

{BASE_URL}/signup

Payload

{
  "name" : "adleena bos",
  "email": "adleena@example.com",
  "password": "yourpassword"
}

Response 
{
    "success":  true,
    "message": "Signup successfully",
    "data": {
        "name" : "adleena bos" ,
        "email": "ad@example.com",
}
Tanusingh02 commented 10 months ago

Here is the required API - POST - login

BASE_URL = /api/v1/admin
POST {BASE_URL }/login

params 
 none

payload 
{string} email
{string} password

Example

{BASE_URL}/login

Payload

{
  "email": "adleena@example.com",
  "password": "yourpassword"
}

Response 
{
    "success": true,
    "response": {
        "message": "Logged in successfully",
        "data": {
            "name": "adleena bos",
            "email": "ad@example.com",
        }
    }
}