Download the PHP package oliveris/sdk-mycrystalhub without Composer
On this page you can find all versions of the php package oliveris/sdk-mycrystalhub. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download oliveris/sdk-mycrystalhub
More information about oliveris/sdk-mycrystalhub
Files in oliveris/sdk-mycrystalhub
Package sdk-mycrystalhub
Short Description A PHP-SDK for MyCrystalHub API
License MIT
Informations about the package sdk-mycrystalhub
MyCrystalHub SDK
PHP-SDK for MyCrystalHub API
Used to access your companies data.
Usage
Pull in the composer package by running the command below:
Import the Crystal namespace into the class (autoloading)
Examples
Setting your API environment
Below shows an example if you need to access a different environments API, for example, staging. By default it is set on production.
Retrieving all of the companies clients
Below is a basic example of how to make a request to retrieve your companies clients.
Retrieving all of the companies quotes
Below is a basic example of how to make a request to retrieve your companies quotes.
Retrieving all of the companies jobs
Below is a basic example of how to make a request to retrieve your companies jobs.
Retrieving all of the companies invoices
Below is a basic example of how to make a request to retrieve your companies invoices.
Retrieving all of the companies employees
Below is a basic example of how to make a request to retrieve your companies employees.
Retrieving a single client
Below is a basic example of how to make a request to retrieve a single client.
The $client_id variable should be an integer type.
Retrieving a single quote
Below is a basic example of how to make a request to retrieve a single quote.
The $quote_ref variable should be a string type, eg 'QU1/1'.
Retrieving a single job
Below is a basic example of how to make a request to retrieve a single job.
The $job_ref variable should be a string type, eg 'JO1/1'.
Retrieving a single invoice
Below is a basic example of how to make a request to retrieve a single invoice.
The $invoice_ref variable should be a string type, eg 'IN1/1'.
Retrieving a single employee
Below is a basic example of how to make a request to retrieve a single employee.
The $employee_id variable should be an integer type.
License
MyCrystalHub is open-sourced software licensed under the MIT license.