Login
API access.
Email
Intro
A verification email will be sent. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec vel dolor lacinia, pellentesque ligula vitae, ultrices dui. In tincidunt velit sit amet neque aliquet, a vulputate purus lobortis.
Request Headers
Origin: <CLIENT_APP_URL>
client_id: <API_CLIENT_ID>
Request body
{
"email":"String",
"password":"String",
}
Body Validation
- email - User Email
- password- User password
Request
POST
http://localhost:5501/api/v1/auth/login
Response
{
"status": "String",
"token": "String",
}
Response Validation
- status - request status
- token - User access token
Example
Headers
Origin: http://localhost:3000
client_id: pSpisBrYn4yIP1vGILcdZ
Body
{
"email"::"user@example.com",
"password":"12345678"
}
Response
{
"status": "success",
"token": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
}
Mobile
Intro
A verification sms will be sent. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec vel dolor lacinia, pellentesque ligula vitae, ultrices dui. In tincidunt velit sit amet neque aliquet, a vulputate purus lobortis.
Request Headers
Origin: <CLIENT_APP_URL>
client_id: <API_CLIENT_ID>
Request body
{
"phone":"String",
"password":"String"
}
Body Validation
- phone - User phone
- password- User password
Request
POST
http://localhost:5501/api/v1/auth/login/mobile
Response
{
"status": "String",
"token": "String"
}
Response Validation
- status - request status
- token - User access token
Example
Headers
Origin: http://localhost:3000
client_id: pSpisBrYn4yIP1vGILcdZ
Body
{
"phone":"254710xxxxxx",
"password":"12345678"
}
Response
{
"status": "success",
"token": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
}
Google
Intro
A google account will be required. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec vel dolor lacinia, pellentesque ligula vitae, ultrices dui. In tincidunt velit sit amet neque aliquet, a vulputate purus lobortis.
Request Headers
Origin: <CLIENT_APP_URL>
client_id: <API_CLIENT_ID>
Request body
{
"token":"String",
"name":"String",
"email":"String",
"photo":"String",
}
Body Validation
- token - google success login token
- name - google user name
- email - google user email
- token - google user photo
Request
POST
http://localhost:5501/api/v1/auth/oauth/google/logins
Response
{
"status": "String",
"token": "String",
}
Response Validation
- status - request status
- token - User access token
Example
Headers
Origin: http://localhost:3000
client_id: pSpisBrYn4yIP1vGILcdZ
Body
{
"token":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
}
Response
{
"status": "success",
"token": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
}