PHPackages upcc/gsx-rest-php - 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. upcc/gsx-rest-php ActiveLibrary[API Development](/categories/api) upcc/gsx-rest-php ================= An interface to Apple's GSX RESTful API 1856[2 issues](https://github.com/UniversityPCCare/gsx-rest-php/issues)PHP Since Nov 8Pushed 2y ago3 watchersCompare [ Source](https://github.com/UniversityPCCare/gsx-rest-php)[ Packagist](https://packagist.org/packages/upcc/gsx-rest-php)[ RSS](/packages/upcc-gsx-rest-php/feed)WikiDiscussions master Synced 1w ago READMEChangelogDependenciesVersions (1)Used By (0) About ===== [](#about) GSX-Rest is a PHP library that handles interactions with Apple's GSX REST API. It is a spiritual successor to [filipp/gsxlib](https://github.com/filipp/gsxlib)used to interact with Apple's GSX SOAP API, which was retired in late 2019. Requirements ============ [](#requirements) - PHP >7.0 - MySQL (for authorization token persistence) - GSX Client Certificate and Configuration (see below) - GSX account with "Web Services" privilege enabled in MyAccess (see below) Installation ============ [](#installation) - Clone the repo using `git clone https://github.com/UniversityPCCare/gsx-rest-php.git` - Setup a MySQL instance if you haven't already. Create a database (default database name is `gsxrest`) and associate a user with it. Alternatively, in `config/config.ini` you can provide a MySQL user with sufficient privilege to create databases and the database will be created for you. - Rename `config/config.ini.example` to `config/config.ini` and set default configuration values - (Optional) Rename `tests/test_declarations.php.example` to `tests/test_declaration.php` and setup variables within. This is only necessary if you choose to run `tests/test.php` to verify your setup is working. - (Optional) After setting up `test_declarations.php`, `cd tests` and run `php ./test.php` - Upon first run, the database will be created for you (if you hadn't made it already), as well as the tables within. Upgrading to v2 REST API from v1 ================================ [](#upgrading-to-v2-rest-api-from-v1) Apple made changes to the authentication API for v2 of their API. All authentication functions must go through `/api`, whereas all GSX API requests must go through `/gsx/api`. Additionally, there is a new Base URL. If you are upgrading from v1, make the following changes to `config.ini`: - Change variable `REST_BASE_URL` to the appropriate Base URL as found in eServiceCentral. The Base URL changed in v2. - Add variable `REST_AUTH_PATH` with value `/api` - Add variable `REST_GSX_PATH` with value `/gsx/api` - Add variable `API_VERSION` with value `v2`. Must be typed exactly as it is here. Configuration ============= [](#configuration) This library can be configured either by setting values in a `config.ini` file or by passing in an associative array of options in a `key => value` format. For example, `["SOLD_TO" => "0123456789", ... ]` Basic configuration requires the following parameters: - `PHP_TZ`: A valid [PHP Timezone](https://www.php.net/manual/en/timezones.php) (ie `America/New_York`) - `STORAGE`: The storage method for persistence. Currently only supports MySQL, but SQLite support is planned. - `[DATABASE]`: A set of connection parameters for MySQL (`HOST`, `PORT`, `DB`, `USER`, `PASS`) Both the REST and the SOAP API require the following parameters: - `SOLD_TO`: Your Sold-To account number, provided by Apple. The REST API requires the following parameters: - `REST_CERT_PATH`: Path to the certificate bundle in `.pem` format. This will be the `AppleCare-Partner-##########.Prod.apple.com.chain.pem`file you obtain from Apple with your private key appended. Note that you must request separate certificates, one for each API. Keep this in a safe place, not in your web directory! - `REST_CERT_PASS`: Password for your private key. - `REST_BASE_URL`: The base URL used for making calls to the REST API, found in eServiceCentral - `ACCEPT_LANGUAGE`: The `Accept-Language` header. Default is en\_US. Other options are available, found in eServiceCentral The SOAP API is deprecated and will be removed from this library. Until Apple completely replaces the SOAP API, this library will implement all legacy SOAP functions as well. The SOAP API requires the following parameters: - `SOAP_CERT_PATH`: Path to the certificate bundle in `.pem` format. Like `REST_CERT_PATH`, this is the "chain.pem" certificate provided by Apple, with your private key appended. Note that you must request separate certificates, one for each API. - `SOAP_CERT_PASS`: Password for your private key, in case you used a separate private key for your SOAP certificate - `SOAP_WSDL_URL`: Path to the WSDL file. This can either be the URL provided to you by Apple (in which chase your program will have to make a separate HTTP request to retrieve the WSDL for every instance of GSXHandler) or you can download the file and store it somewhere (like in the `config/` folder) and set this variable as the path to the downloaded file. - `SOAP_ENVIRONMENT`: Will either be `ut` (for test environment) or `it` (for production environment). - `SOAP_REGION`: Your region code, see REST API documentation in GSX for valid codes (default is `am` for America) - `SOAP_TIMEZONE`: A Timezone abbreviation (default: `EST`). - `SOAP_LANGUAGE`: A valid language code (default: `en` for English) according to GSX REST API Documentation Usage ===== [](#usage) After setting up `config\config.ini`: ```