PHPackages                             funmula/biggo-api-php-pms-client - 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. [API Development](/categories/api)
4. /
5. funmula/biggo-api-php-pms-client

ActiveLibrary[API Development](/categories/api)

funmula/biggo-api-php-pms-client
================================

BigGo API PMS PHP Client is a API written in PHP

v1.0.0(2y ago)05MITPHPPHP >=7.4

Since Jul 19Pushed 2w ago1 watchersCompare

[ Source](https://github.com/Funmula-Corp/biggo-api-php-pms-client)[ Packagist](https://packagist.org/packages/funmula/biggo-api-php-pms-client)[ RSS](/packages/funmula-biggo-api-php-pms-client/feed)WikiDiscussions main Synced today

READMEChangelog (1)Dependencies (1)Versions (2)Used By (0)

🐘 BigGo PMS API — PHP Client
============================

[](#-biggo-pms-api--php-client)

> 🛒 BigGo PMS (Price Monitoring System) 的官方 PHP client，讓你用幾行程式碼就能存取平台、群組與歷史報表。

[![Packagist](https://camo.githubusercontent.com/d66ef2f7fbfe8824084ed3b9b3f4c05eae3577b3ef2b020fac1ff8327ef66a60/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f5061636b61676973742d66756e6d756c61253246626967676f2d2d6170692d2d7068702d2d706d732d2d636c69656e742d6f72616e67653f6c6f676f3d7061636b6167697374266c6f676f436f6c6f723d7768697465)](https://packagist.org/packages/funmula/biggo-api-php-pms-client)[![PHP](https://camo.githubusercontent.com/9bb4aca8974f8fd9e14ddff75d40315ba566c0f89c646b13994759a1db4f0995/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f5048502d372e342532422d3737374242343f6c6f676f3d706870266c6f676f436f6c6f723d7768697465)](https://www.php.net/)[![License](https://camo.githubusercontent.com/784362b26e4b3546254f1893e778ba64616e362bd6ac791991d2c9e880a3a64e/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4c6963656e73652d4d49542d677265656e2e737667)](./LICENSE)

---

✨ Features
----------

[](#-features)

- 🔑 **自動 token 管理** — 自動處理 OAuth2 `client_credentials` 換發與過期續期
- 🏬 **平台 / 群組 / 報表** — 完整存取 PMS 資源階層
- 📦 **多格式下載** — 支援 `csv` / `excel` / `json` 報表下載，可直接存檔
- 🧩 **零相依** — 僅使用 PHP 內建的 cURL 與 JSON 擴充

---

📑 Table of Contents
-------------------

[](#-table-of-contents)

- [🚀 Getting Started](#-getting-started)
    - [📥 Installation](#-installation)
    - [🏗️ Initializing](#%EF%B8%8F-initializing)
    - [📡 Accessing BigGo PMS API](#-accessing-biggo-pms-api)
- [🧭 How It Works](#-how-it-works)
- [📚 API Reference](#-api-reference)
- [📄 License](#-license)

---

🚀 Getting Started
-----------------

[](#-getting-started)

### 📥 Installation

[](#-installation)

使用 composer：

```
composer require funmula/biggo-api-php-pms-client
```

### 🏗️ Initializing

[](#️-initializing)

先從 BigGo API 取得 client id 與 secret，再用以下程式碼建立 API 物件：

```
use Funmula\BiggoApiPhpPmsClient\BiggoPMSAPI;

$api = new BiggoPMSAPI(
  '',
  ''
);
```

> 💡 還沒有 client id / secret？請參考 👉 [Funmula-Corp/guide](https://github.com/Funmula-Corp/guide)

### 📡 Accessing BigGo PMS API

[](#-accessing-biggo-pms-api)

```
// 🏬 取得使用者可存取的平台列表
$platformList = $api->getPlatformList();

// 👥 取得平台內的群組列表
$groupList = $api->getGroupList('');

// 📊 取得平台內的歷史報表列表
$reportList = $api->getReportList('');

// 📥 取得報表內容，或直接存成檔案
$reportJson = $api->getReport('', '', 'json');
```

> 📖 更多細節請參考 [完整文件](./doc/README.md)。

---

🧭 How It Works
--------------

[](#-how-it-works)

🔐 **認證流程**：SDK 會在建立時自動換發 token，並在過期前自動續期。

 ```
sequenceDiagram
    participant App as 🧑‍💻 Your App
    participant SDK as 🐘 BiggoPMSAPI
    participant Auth as 🔐 auth.biggo.com
    participant API as 📡 api.biggo.com/pms

    App->>SDK: new BiggoPMSAPI(clientID, clientSecret)
    Note over SDK: token 不存在或已過期？
    SDK->>Auth: POST /auth/v1/token (client_credentials)
    Auth-->>SDK: access_token + expires_in
    App->>SDK: getPlatformList()
    SDK->>API: GET /platform (Bearer token)
    API-->>SDK: 平台資料
    SDK-->>App: array
```

      Loading 🗂️ **資源階層**：平台底下有群組，群組會產生報表，報表可下載成多種格式。

 ```
flowchart LR
    A[🏬 Platform] --> B[👥 Group]
    B --> C[📊 Report]
    C --> D{📥 getReport}
    D --> E[📄 CSV]
    D --> F[📈 Excel]
    D --> G[🔧 JSON]
```

      Loading ---

📚 API Reference
---------------

[](#-api-reference)

方法說明回傳`getPlatformList()`🏬 取得可存取的平台列表`array``getGroupList($platformID)`👥 取得平台內的群組列表`array``getReportList($platformID, $options = [])`📊 取得歷史報表列表`array``getReport($platformID, $reportID, $fileType, $saveAsFile = false, $filePath = '', $fileName = '')`📥 下載報表（`csv`/`excel`/`json`）內容或檔案路徑`isTokenExpired()`⏳ 檢查 token 是否過期`bool``getReportList` 的 `$options` 可帶 `size`、`in_sort`、`in_form`、`pms_groupid`、`start`、`end`。

---

📄 License
---------

[](#-license)

[MIT](./LICENSE)

###  Health Score

32

—

LowBetter than 69% of packages

Maintenance63

Regular maintenance activity

Popularity4

Limited adoption so far

Community10

Small or concentrated contributor base

Maturity44

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 80% of commits — single point of failure

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

Unknown

Total

1

Last Release

1079d ago

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/139940245?v=4)[Benson-funmula](/maintainers/Benson-funmula)[@Benson-funmula](https://github.com/Benson-funmula)

---

Top Contributors

[![Benson-funmula](https://avatars.githubusercontent.com/u/139940245?v=4)](https://github.com/Benson-funmula "Benson-funmula (8 commits)")[![chifunmula](https://avatars.githubusercontent.com/u/125954518?v=4)](https://github.com/chifunmula "chifunmula (1 commits)")[![kevinwatt](https://avatars.githubusercontent.com/u/171228?v=4)](https://github.com/kevinwatt "kevinwatt (1 commits)")

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/funmula-biggo-api-php-pms-client/health.svg)

```
[![Health](https://phpackages.com/badges/funmula-biggo-api-php-pms-client/health.svg)](https://phpackages.com/packages/funmula-biggo-api-php-pms-client)
```

###  Alternatives

[exsyst/swagger

A php library to manipulate Swagger specifications

35916.4M7](/packages/exsyst-swagger)[hubspot/api-client

Hubspot API client

24016.2M20](/packages/hubspot-api-client)[pocketmine/bedrock-protocol

An implementation of the Minecraft: Bedrock Edition protocol in PHP

172445.0k12](/packages/pocketmine-bedrock-protocol)[botman/driver-telegram

Telegram driver for BotMan

93459.5k6](/packages/botman-driver-telegram)

PHPackages © 2026

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