Download the PHP package close/partner-sdk without Composer
On this page you can find all versions of the php package close/partner-sdk. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download close/partner-sdk
More information about close/partner-sdk
Files in close/partner-sdk
Package partner-sdk
Short Description Official SDK for Close partners.
License Apache-2.0
Informations about the package partner-sdk
Close SDK for PHP
The Close SDK for PHP makes it easy for developers to communicate with The Close App in their PHP code. Get started really fast by installing the SDK through Composer.
Jump To:
- Getting Started
- Quick Examples
- Full user guide
- Getting Help
- Features
- Contributing
- Other Resources
Getting Started
- Get your credentials – Before you begin, you need to already have an account with Close. If that is not the case, feel free to contact us.
- Minimum requirements – In order to use the Close SDK, your system will need to meet the [minimum requirements][docs-requirements], which includes having PHP >= 7.4.
-
Install the SDK – The recommended way to use the Close SDK is by installing it with Composer:
- Using the SDK – In this page you will learn how to use the SDK, but if you want to get more information about the calls, you can always see our Close Partner API Documentation, which this SDK is a wrapper of.
Quick Examples
Create the Close SDK client
Import tickets using the Close App
Import ticket with required information
Import ticket with seat information
Cancelling tickets
Cancel a ticket in the Close App
Sending messages
Send a message to all users in a chat
Flow Properties
To set a value in the flow properties
Setting properties in the chat
You can also retrieve and set properties that will be available for everyone who is in the chat of the show.
For retrieving all the flow properties:
For setting a property for the whole chat:
Getting Help
Feel free to let us know if you have encountered any questions or problems using our SDK. We will try to make sure that we will get back to you as soon as possible.
- If you have questions that have not been answered in this documentation, please contact us.
- If you think that you may have found a bug, feel free to open an issue.
Features
- Provides a very easy way to communicate with our Partner API for all of the supported endpoints. This means that we always fetch the correct data based on your API credentials.
- It is built on the latest software, with the highest security standards and following the PSR conventions.
- You can provide your own Http client as a dependency of the client builder and providing the instance in the options object. You have an example above.
- We use Guzzle to generate these requests, and we make use of its technology (async requests, middlewares, etc.).
- We provide a data structure f our domain that can be easily used by external PHP applications.
- We give back clear responses and exceptions in case something doesn't go as expected.
Advanced features
- In case you want to make usage of your own HttpClient, you can provide the implementation to the client builder when instantiating our SDK:
Important: The client needs to implement the PSR-7 conventions to be accepted by our SDK.
- In case you don't provide any instance, we use the discovery functionality from HttpPlug, which look up for an available implementation of
\Http\Client\HttpClient
.
Contributing
If you have ideas on how to improve our SDK, don't hesitate to open an issue and let us know! If you already have code ready that would help us improve our system, you are free to open a PR. All the extra help is highly appreciated!
Resources
All versions of partner-sdk with dependencies
psr/http-factory Version ^1.0
psr/http-client Version ^1.0
php-http/client-common Version ^2.5
php-http/discovery Version ^1.14
symfony/options-resolver Version ^5.4
ext-json Version *
php-http/guzzle7-adapter Version ^1.0