Bagisto REST API

Bagisto REST API is a medium to use the features of the core Bagisto System. By using Bagisto REST API, you can integrate your application to serve the default content of Bagisto.

1. Requirements:

• Bagisto: v2.0.0

2. Installation:

To install Bagisto REST API from your console:

For Bagisto v2.0:

composer require bagisto/rest-api:2.0.0

For Bagisto v1.4.5:

composer require bagisto/rest-api:1.4.5

For the master version:

composer require bagisto/rest-api:dev-master

Note: It is not recommended to use the master version as it may contain breaking changes.

Add below options in the .env file (i.e. http://localhost/public your domain):

SANCTUM_STATEFUL_DOMAINS=http://localhost/public

To configure the REST API L5-Swagger Documentation run below command:

php artisan bagisto-rest-api:install

To check the Admin end API documentation:

http://localhost/public/api/admin/documentation

To check the Shop end API documentation:

http://localhost/public/api/shop/documentation

• You can check the L5-Swagger guidelines too regarding the configuration the API documentation.

For admin login

• To add Laravel Sanctum's API token to the Admin model follow the given path.

packages/Webkul/User/src/Models/Admin.php

<?php
namespace Webkul\User\Models;

use Laravel\Sanctum\HasApiTokens;

class Admin extends Authenticatable implements AdminContract
{
    use HasApiTokens;
    ...
}

For customer login

• To add Laravel Sanctum's API token to the customer model follow the given path.

packages/Webkul/Customer/src/Models/Customer.php

For master

<?php
namespace Webkul\Customer\Models;

use Laravel\Sanctum\HasApiTokens;

class Customer extends Authenticatable implements CustomerContract
{
    use HasApiTokens;
    ...
}