Download the PHP package wataridori/chatwork-sdk without Composer
On this page you can find all versions of the php package wataridori/chatwork-sdk. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download wataridori/chatwork-sdk
More information about wataridori/chatwork-sdk
Files in wataridori/chatwork-sdk
Package chatwork-sdk
Short Description Just a non-official SDK for Chatwork
License GPL-3.0
Informations about the package chatwork-sdk
Chatwork SDK for PHP
API Docs
Remember that this SDK is non-official. It may not work when Chatwork update their APIs in the feature.
(However, I will try to cover all the changes from Chatwork. If something goes wrong, please let me know)
Chatwork SDK now supports Chatwork API version 2
Check the Chatwork API Document here
Requirement
- PHP >= 5.4
- PHP cURL
Install
You can install and manage Chatwork SDK for PHP by using Composer
Or add wataridori/chatwork-sdk
into the require section of your composer.json
file then run composer update
Usage
Firstly, to use Chatwork API, you must register an API Key.
Pass your key to ChatworkSDK
class.
If you have problems with the SSL Certificate Verification, you can turn it off by the following setting.
Now you can easily use many functions to access Chatwork API Endpoints.
ChatworkSDK's Classes
ChatworkAPI: This is the class that contains base API. You can use it to send request to Chatwork and receive the response in array.
ChatworkSDK also provides many others class that help you to work in more object oriented way.
- ChatworkRoom: Use for store Room Information, with many functions to work with Room
- ChatworkUser: Use for store User Information.
- ChatworkMessage: Use for store Message Information.
The 3 classes above are extended from the ChatworkBase
class. ChatworkBase
provides you some useful function to work with messages.
You can easily build a TO message, REPLY or QUOTE message.
Check ChatworkSDK functions list here for further details and usages.
Run test
- Create a file named
config.json
inside thetests/fixtures/
folder. -
Input your API Key, and a test Room into
config.json
file. It should look like this: - Then run
phpunit
to start testing.
Contribution
View contribution guidelines here