funmula/biggo-api-php-pms-client

BigGo API PMS PHP Client is a API written in PHP

v1.0.0 2023-07-19 06:34 UTC

This package is auto-updated.

Last update: 2024-12-19 10:01:07 UTC


README

BigGo PMS API PHP Client is a API written in PHP.

short future:

Getting Started

Installation

Using composer

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

Initializing

To get started, first obtain a client id and secret from BigGo API. Then, use the following code to obtain an API object:

$api = new BiggoPMSAPI(
  '<Your client ID>',
  '<Your client secret>'
  );

You can refer to this guide to get the client id and secret

Funmula-Corp/guide

Accessing BigGo PMS API

You can access all BigGo PMS API resources using the api object. Simply use the object obtained from new BiggoPMSAPI(). For example:

// Get list of platforms the user has access.
$platformList = $api->getPlatformList();
// Get list of groups in the platform.
$groupList = $api->getGroupList('<Platform ID>')
// Get list of reports in the platform.
$reportList = $api->getReportList('<Platform ID>')
// Get file content or save report as file.
$reportJson = $api->getReport('<Platform ID>', '<Report ID>', 'json')

if you need more information, you can refer to this document.

Typescript

This library supports typescript.

License

MIT