PHPackages                             bagisto/graphql-api - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Authentication &amp; Authorization](/categories/authentication)
4. /
5. bagisto/graphql-api

ActiveLibrary[Authentication &amp; Authorization](/categories/authentication)

bagisto/graphql-api
===================

Bagisto GraphQL API

v2.3.2(10mo ago)11326.1k↓79.5%82[19 issues](https://github.com/bagisto/headless-ecommerce/issues)[5 PRs](https://github.com/bagisto/headless-ecommerce/pulls)MITPHP

Since Dec 7Pushed 5mo ago7 watchersCompare

[ Source](https://github.com/bagisto/headless-ecommerce)[ Packagist](https://packagist.org/packages/bagisto/graphql-api)[ RSS](/packages/bagisto-graphql-api/feed)WikiDiscussions main Synced 3w ago

READMEChangelog (10)Dependencies (3)Versions (18)Used By (0)

Bagisto GraphQL API
===================

[](#bagisto-graphql-api)

 [ ![Total Downloads](https://camo.githubusercontent.com/41ec7db15ecd8e6e4acb2fb799422c0fb85bfd419613f0d0f69a79e9ad36b2a1/68747470733a2f2f706f7365722e707567782e6f72672f6261676973746f2f6772617068716c2d6170692f642f746f74616c2e737667) ](https://packagist.org/packages/bagisto/graphql-api) [ ![Latest Stable Version](https://camo.githubusercontent.com/bf092441ce11c8ca4871f35c5a2fce3c689039e440eef3b153eebb631bf4d873/68747470733a2f2f706f7365722e707567782e6f72672f6261676973746f2f6772617068716c2d6170692f762f737461626c652e737667) ](https://packagist.org/packages/bagisto/graphql-api) [ ![License](https://camo.githubusercontent.com/05b4718a71b04e58574f1a6cf13b6b5fa62769889bef7dcecf0375c1b3933eb9/68747470733a2f2f706f7365722e707567782e6f72672f6261676973746f2f6772617068716c2d6170692f6c6963656e73652e737667) ](https://packagist.org/packages/bagisto/graphql-api)

Bagisto's GraphQL API enables a seamless, headless eCommerce experience built on Laravel. This API delivers ultra-fast, dynamic, and personalized shopping experiences through a scalable, open-source platform.

**Read our full documentation: [Bagisto GraphQL API Docs](https://devdocs.bagisto.com/2.3/api/graphql-api.html)**

This API was developed in collaboration with the [Ucraft Team](https://www.ucraft.com/).

---

### Requirements:

[](#requirements)

- **Bagisto**: ^2.3.0

---

### Installation:

[](#installation)

To install the Bagisto GraphQL API, follow these steps:

1. **Install via Composer**

    Run the following command in your terminal to install the GraphQL API package:

    ```
    composer require bagisto/graphql-api:dev-main
    ```
2. **Run the following commands to complete the setup**

    ```
    php artisan bagisto-graphql:install
    ```

---

### Usage:

[](#usage)

1. **GraphQL Playground**

    After installation, you can test your API through the GraphQL Playground. Visit:

    ```
    http://your-domain.com/graphiql

    ```
2. **Postman Integration**

    Alternatively, you can test the API using Postman by accessing:

    ```
    http://your-domain.com/graphql

    ```

---

### 3. Authorization

[](#3-authorization)

To call certain APIs, you need to include `x-app-secret-key` in the request header.

1. **Set the Key**

    The `APP_SECRET_KEY` is generated automatically during installation and stored in your `.env` file:

    ```
    APP_SECRET_KEY=generated-secret-key
    ```
2. **Share Securely**

    Provide this key to the frontend or mobile team as needed.
3. **Include in Requests**

    Add the header to your API calls:

    ```
    x-app-secret-key: generated-secret-key

    ```

---

4. **GraphQL Playground Endpoint Configuration**

    Ensure that the `GRAPHQL_ENDPOINT` in your `.env` file is set to your application's URL followed by `/graphiql`. For example:

    ```
    GRAPHQL_ENDPOINT=https://your-domain.com/graphiql
    ```
5. **Cache Your GraphQL Schema for Better Performance**

    To avoid rebuilding the schema on every request, you can cache it. This improves performance significantly in production environments.

    Run the following Artisan command to cache the schema:

    ```
    php artisan lighthouse:cache
    ```

    If you make changes to your schema, remember to clear the cache:

    ```
    php artisan lighthouse:clear-cache
    ```

---

That's it! Your Bagisto GraphQL API is now ready. Execute the project on your specified domain and start building your headless eCommerce solution.

###  Health Score

51

—

FairBetter than 95% of packages

Maintenance61

Regular maintenance activity

Popularity46

Moderate usage in the ecosystem

Community27

Small or concentrated contributor base

Maturity59

Maturing project, gaining track record

 Bus Factor2

2 contributors hold 50%+ of commits

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~83 days

Recently: every ~13 days

Total

17

Last Release

319d ago

Major Versions

v1.4.7 → v2.0.02023-11-30

### Community

Maintainers

![](https://www.gravatar.com/avatar/016ec12a9caaedb7c6003878edfc412b2e9a5159e75bac4338ab7eeaaec9d92d?d=identicon)[Vivek Sharma](/maintainers/Vivek%20Sharma)

---

Top Contributors

[![vivek-webkul](https://avatars.githubusercontent.com/u/28401696?v=4)](https://github.com/vivek-webkul "vivek-webkul (214 commits)")[![mayank-webkul](https://avatars.githubusercontent.com/u/126044198?v=4)](https://github.com/mayank-webkul "mayank-webkul (188 commits)")[![anmol-webkul](https://avatars.githubusercontent.com/u/79086253?v=4)](https://github.com/anmol-webkul "anmol-webkul (176 commits)")[![rachana-webkul](https://avatars.githubusercontent.com/u/120095673?v=4)](https://github.com/rachana-webkul "rachana-webkul (50 commits)")[![deepaksinghgusain227](https://avatars.githubusercontent.com/u/69623394?v=4)](https://github.com/deepaksinghgusain227 "deepaksinghgusain227 (49 commits)")[![shivendra-webkul](https://avatars.githubusercontent.com/u/121868701?v=4)](https://github.com/shivendra-webkul "shivendra-webkul (18 commits)")[![devansh-webkul](https://avatars.githubusercontent.com/u/68321766?v=4)](https://github.com/devansh-webkul "devansh-webkul (15 commits)")[![rohansingh754](https://avatars.githubusercontent.com/u/135021620?v=4)](https://github.com/rohansingh754 "rohansingh754 (7 commits)")[![rahulrajkosta-webkul](https://avatars.githubusercontent.com/u/196308656?v=4)](https://github.com/rahulrajkosta-webkul "rahulrajkosta-webkul (6 commits)")[![naresh-webkul](https://avatars.githubusercontent.com/u/48952272?v=4)](https://github.com/naresh-webkul "naresh-webkul (5 commits)")[![shivamwebkul](https://avatars.githubusercontent.com/u/121859762?v=4)](https://github.com/shivamwebkul "shivamwebkul (2 commits)")[![trane77](https://avatars.githubusercontent.com/u/12503478?v=4)](https://github.com/trane77 "trane77 (1 commits)")[![vipinyadavakeneo](https://avatars.githubusercontent.com/u/100278669?v=4)](https://github.com/vipinyadavakeneo "vipinyadavakeneo (1 commits)")[![amit-webkul](https://avatars.githubusercontent.com/u/121479029?v=4)](https://github.com/amit-webkul "amit-webkul (1 commits)")[![ashishkumar-webkul](https://avatars.githubusercontent.com/u/92721837?v=4)](https://github.com/ashishkumar-webkul "ashishkumar-webkul (1 commits)")[![jitendra-webkul](https://avatars.githubusercontent.com/u/39991107?v=4)](https://github.com/jitendra-webkul "jitendra-webkul (1 commits)")[![Ticket-Master](https://avatars.githubusercontent.com/u/77227724?v=4)](https://github.com/Ticket-Master "Ticket-Master (1 commits)")

---

Tags

bagistocartecommercegraphqlgraphql-apiheadlessheadless-commercejwtlaravelopensourcephp

### Embed Badge

![Health badge](/badges/bagisto-graphql-api/health.svg)

```
[![Health](https://phpackages.com/badges/bagisto-graphql-api/health.svg)](https://phpackages.com/packages/bagisto-graphql-api)
```

###  Alternatives

[daniel-de-wit/lighthouse-sanctum

Laravel Sanctum support for Laravel Lighthouse.

60121.5k](/packages/daniel-de-wit-lighthouse-sanctum)[yakovenko/laravel-lighthouse-graphql-multi-schema

A Laravel package that provides multi-schema support for Lighthouse GraphQL.

17112.5k](/packages/yakovenko-laravel-lighthouse-graphql-multi-schema)[uabookstores/laravel-shibboleth

Enable basic Shibboleth support for Laravel 5.x

189.0k](/packages/uabookstores-laravel-shibboleth)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
