nshop/packages/Webkul/BagistoApi

Bagisto API Platform

Comprehensive REST and GraphQL APIs for seamless e-commerce integration and extensibility.

Installation

Method 1: Quick Start (Composer Installation – Recommended)

The fastest way to get started:

composer require bagisto/bagisto-api
php artisan bagisto-api-platform:install

Your APIs are now ready! Access them at:

• REST API Docs: https://your-domain.com/api/docs
• GraphQL Playground: https://your-domain.com/graphql

Method 2: Manual Installation

Use this method if you need more control over the setup.

Step 1: Download and Extract

1. Download the BagistoApi package from GitHub
2. Extract it to: packages/Webkul/BagistoApi/

Step 2: Register Service Provider

Edit bootstrap/providers.php:

<?php

return [
    // ...existing providers...
    Webkul\BagistoApi\Providers\BagistoApiServiceProvider::class,
    // ...rest of providers...
];

Step 3: Update Autoloading

Edit composer.json and update the autoload section:

{
  "autoload": {
    "psr-4": {
      "Webkul\\BagistoApi\\": "packages/Webkul/BagistoApi/src"
    }
  }
}

Step 4: Install Dependencies

# Install required packages
composer require api-platform/laravel:v4.1.25
composer require api-platform/graphql:v4.2.3

Step 5: Run the installation

php artisan bagisto-api-platform:install

Step 9: Environment Setup (Update in the .env)

STOREFRONT_DEFAULT_RATE_LIMIT=100
STOREFRONT_CACHE_TTL=60
STOREFRONT_KEY_PREFIX=storefront_key_
STOREFRONT_PLAYGROUND_KEY=pk_storefront_xxxxxxxxxxxxxxxxxxxxxxxxxx 
API_PLAYGROUND_AUTO_INJECT_STOREFRONT_KEY=true

Access Points

Once verified, access the APIs at:

• REST API (Shop): https://your-domain.com/api/shop/
• REST API (Admin): https://your-domain.com/api/admin/
• GraphQL Endpoint: https://your-domain.com/graphql`
• GraphQL Playground: https://your-domain.com/graphqli

Documentation

• Bagisto API: Demo Page
• API Documentation: Bagisto API Docs
• GraphQL Playground: Interactive Playground

Support

For issues and questions, please visit:

• GitHub Issues
• Bagisto Documentation
• Community Forum

📝 License

The Bagisto API Platform is open-source software licensed under the MIT license.