🔁APIs

you can show the APIs Endpoints here

you can activate this feature or stop it from the config file and use your own routes or your own controllers.

to make this endpoint work fine you need to add a custom gruid inside /config/auth.php to be like this

<?php

return [

    /*
    |--------------------------------------------------------------------------
    | Authentication Defaults
    |--------------------------------------------------------------------------
    |
    | This option controls the default authentication "guard" and password
    | reset options for your application. You may change these defaults
    | as required, but they're a perfect start for most applications.
    |
    */

    'defaults' => [
        'guard' => 'web',
        'passwords' => 'users',
    ],

    /*
    |--------------------------------------------------------------------------
    | Authentication Guards
    |--------------------------------------------------------------------------
    |
    | Next, you may define every authentication guard for your application.
    | Of course, a great default configuration has been defined for you
    | here which uses session storage and the Eloquent user provider.
    |
    | All authentication drivers have a user provider. This defines how the
    | users are actually retrieved out of your database or other storage
    | mechanisms used by this application to persist your user's data.
    |
    | Supported: "session"
    |
    */

    'guards' => [
        'web' => [
            'driver' => 'session',
            'provider' => 'users',
        ],
        'accounts' => [
            'driver' => 'session',
            'provider' => 'accounts',
        ]
    ],

    /*
    |--------------------------------------------------------------------------
    | User Providers
    |--------------------------------------------------------------------------
    |
    | All authentication drivers have a user provider. This defines how the
    | users are actually retrieved out of your database or other storage
    | mechanisms used by this application to persist your user's data.
    |
    | If you have multiple user tables or models you may configure multiple
    | sources which represent each model / table. These sources may then
    | be assigned to any extra authentication guards you have defined.
    |
    | Supported: "database", "eloquent"
    |
    */

    'providers' => [
        'users' => [
            'driver' => 'eloquent',
            'model' => App\Models\User::class,
        ],
        'accounts' => [
            'driver' => 'eloquent',
            'model' => \TomatoPHP\TomatoCrm\Models\Account::class,
        ],

        // 'users' => [
        //     'driver' => 'database',
        //     'table' => 'users',
        // ],
    ],

    /*
    |--------------------------------------------------------------------------
    | Resetting Passwords
    |--------------------------------------------------------------------------
    |
    | You may specify multiple password reset configurations if you have more
    | than one user table or model in the application and you want to have
    | separate password reset settings based on the specific user types.
    |
    | The expiry time is the number of minutes that each reset token will be
    | considered valid. This security feature keeps tokens short-lived so
    | they have less time to be guessed. You may change this as needed.
    |
    | The throttle setting is the number of seconds a user must wait before
    | generating more password reset tokens. This prevents the user from
    | quickly generating a very large amount of password reset tokens.
    |
    */

    'passwords' => [
        'users' => [
            'provider' => 'users',
            'table' => 'password_reset_tokens',
            'expire' => 60,
            'throttle' => 60,
        ],
    ],

    /*
    |--------------------------------------------------------------------------
    | Password Confirmation Timeout
    |--------------------------------------------------------------------------
    |
    | Here you may define the amount of seconds before a password confirmation
    | times out and the user is prompted to re-enter their password via the
    | confirmation screen. By default, the timeout lasts for three hours.
    |
    */

    'password_timeout' => 10800,

];

Auth Endpoints

Login

We are using bearer token auth system and you can get token by using this APIs.

POSThttps://cm.test/api/login

Body

application/json

email*string

password*string

Response

200400401422

A user resource with Token.

Body

application/json

status*boolean

message*string

Example: "Data Retrieved Successfully"

data*object

Request

JavaScriptCurlPython

const response = await fetch('https://cm.test/api/login', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "email": "text",
      "password": "text"
    }),
});
const data = await response.json();

Response

200400401422

{
  "status": false,
  "message": "Data Retrieved Successfully",
  "data": {
    "token": "text"
  }
}

Register

You can create a new account by use this API.

POSThttps://cm.test/api/register

Body

multipart/form-data

name*string

phone*string

email*string (email)

password*string

front_id*string (binary)

back_id*string (binary)

relation_typeintegernull

parent_idinteger

password_confirmation*string

Response

200400422

Body

application/json

any of

objectobject

Request

JavaScriptCurlPython

const response = await fetch('https://cm.test/api/register', {
    method: 'POST',
    headers: {
      "Content-Type": "multipart/form-data"
    },
    body: JSON.stringify({
      "name": "text",
      "phone": "text",
      "email": "[e-mail]",
      "password": "text",
      "front_id": "binary",
      "back_id": "binary",
      "password_confirmation": "text"
    }),
});
const data = await response.json();

Response

200400422

{
  "status": false,
  "message": "User registration success",
  "data": {
    "token": "text"
  }
}

Reset Password

You can send reset password request by use this APIs.

POSThttps://cm.test/api/reset

Body

application/json

email*string

Response

200404422

OTP Send Success Using Service Provider.

Body

application/json

status*boolean

message*string

Example: "An OTP Has been send to your email please check it"

Request

JavaScriptCurlPython

const response = await fetch('https://cm.test/api/reset', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "email": "text"
    }),
});
const data = await response.json();

Response

200404422

{
  "status": false,
  "message": "An OTP Has been send to your email please check it"
}

Resend OTP

You can resend OTP by use this API.

POSThttps://cm.test/api/resend

Body

application/json

email*string

Response

200422

OTP Send Success Using Service Provider.

Body

application/json

status*boolean

message*string

Example: "An OTP Has been send to your email please check it"

Request

JavaScriptCurlPython

const response = await fetch('https://cm.test/api/resend', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "email": "text"
    }),
});
const data = await response.json();

Response

200422

{
  "status": false,
  "message": "An OTP Has been send to your email please check it"
}

Check OTP & Active Account

You can check OTP is vaild by use this API and active the user if it's vaild.

POSThttps://cm.test/api/otp

Body

application/json

email*string

otp_code*string

Response

200400404422

OTP is vaild and the account has been activated.

Body

application/json

status*boolean

message*string

Example: "your Account has been activated"

Request

JavaScriptCurlPython

const response = await fetch('https://cm.test/api/otp', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "email": "text",
      "otp_code": "text"
    }),
});
const data = await response.json();

Response

200400404422

{
  "status": false,
  "message": "your Account has been activated"
}

Check OTP

You can check OTP is vaild by use this API.

POSThttps://cm.test/api/otp-check

Body

application/json

email*string

otp_code*string

Response

200400404422

OTP is vaild and the account has been activated.

Body

application/json

status*boolean

message*string

Example: "your Account has been activated"

Request

JavaScriptCurlPython

const response = await fetch('https://cm.test/api/otp-check', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "email": "text",
      "otp_code": "text"
    }),
});
const data = await response.json();

Response

200400404422

{
  "status": false,
  "message": "your Account has been activated"
}

Change Password

If the request of change password has been send success you can change the password with OTP form here.

POSThttps://cm.test/api/password

Body

application/json

password*string

password_confirmation*string

Response

200400404422

OTP is vaild and the password has been changed.

Body

application/json

status*boolean

message*string

Example: "Password Updated"

Request

JavaScriptCurlPython

const response = await fetch('https://cm.test/api/password', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "password": "text",
      "password_confirmation": "text"
    }),
});
const data = await response.json();

Response

200400404422

{
  "status": false,
  "message": "Password Updated"
}

Profile Endpoints

User Profile

You Can Return user resource data from this APIs.

GEThttps://cm.test/api/profile

Response

200404

A user resource with Token.

Body

application/json

status*boolean

message*string

Example: "Profile Data Load"

data*object

Request

JavaScriptCurlPython

const response = await fetch('https://cm.test/api/profile', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200404

{
  "status": false,
  "message": "Profile Data Load"
}

Update User Profile

You can update user data by use this APIs.⚠️Cannot generate request documentation: Undefined variable $user

POSThttps://cm.test/api/profile

Response

200404422

A user resource with Token.

Body

application/json

status*boolean

message*string

Example: "Profile Data Update"

data*object

Request

JavaScriptCurlPython

const response = await fetch('https://cm.test/api/profile', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

200404422

{
  "status": false,
  "message": "Profile Data Update"
}

Update User Password

You can update user password by use this APIs.

POSThttps://cm.test/api/profile/password

Body

application/json

password*string

password_confirmation*string

Response

200404422

If Your Has Token He Can change the password direct without OTP.

Body

application/json

status*boolean

message*string

Example: "Password Updated"

Request

JavaScriptCurlPython

const response = await fetch('https://cm.test/api/profile/password', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "password": "text",
      "password_confirmation": "text"
    }),
});
const data = await response.json();

Response

200404422

{
  "status": false,
  "message": "Password Updated"
}

Close Account

You can close your account by send this request, please note that all data for this user will be deleted and you can register again.

DELETEhttps://cm.test/api/profile/destroy

Body

application/json

object

Response

200

The account has been close you can register again

Body

application/json

status*boolean

message*string

Example: "Account Has Been Deleted"

Request

JavaScriptCurlPython

const response = await fetch('https://cm.test/api/profile/destroy', {
    method: 'DELETE',
    headers: {
      "Content-Type": "application/json"
    },
});
const data = await response.json();

Response

200

{
  "status": false,
  "message": "Account Has Been Deleted"
}

Logout User

You can logout the user by destory tokens and session by use this API.

POSThttps://cm.test/api/profile/logout

Body

application/json

object

Response

200

The user logout success and the tokens destoried.

Body

application/json

status*boolean

message*string

Example: "Logout Success"

Request

JavaScriptCurlPython

const response = await fetch('https://cm.test/api/profile/logout', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
});
const data = await response.json();

Response

200

{
  "status": false,
  "message": "Logout Success"
}