README

This library is unmantained. Check this fork by solutionDrive

PHP Library to process calls to Hipchat's v2 REST API

This package is work in progress and some functionality is not available yet.

Installation

The recommended way to install Hipchatv2ApiClient is through Composer. To install this library, run the command below and you will get the latest version:

composer require gorkalaucirica/hipchat-v2-api-client

Usage

All queries need the following two lines. The first one is to authenticate yourself and the second one creates a client that is used by the API classes to perform requests to the API. That is enough to start, now check the API calls section to see how to use the $client to send requests to the API.

use GorkaLaucirica\HipchatAPIv2Client\Auth\OAuth2;
use GorkaLaucirica\HipchatAPIv2Client\Client;

$auth = new OAuth2('tokenYouCanGetInHipchatSite');
$client = new Client($auth);

Client for private instances

After version 1.5.0 you can set the URL in the constructor to change the base url used by the client (by default uses https://api.hipchat.com

$client = new Client($auth, null, 'https.//api.yourdomain.com');

API calls

All API call methods are located in the API folder. All of them have been documented and all have a link to Hipchat v2 API documentation. Some examples:

Getting user by mention name:

use GorkaLaucirica\HipchatAPIv2Client\API\UserAPI;

$userAPI = new UserAPI($client);
$user = $userAPI->getUser('@gorkalaucirica');

Getting all rooms

use GorkaLaucirica\HipchatAPIv2Client\API\RoomAPI;

$roomAPI = new RoomAPI($client);
$room = $roomAPI->getRooms(array('max-results' => 30));

Current status

The following list shows methods available and missing:

Add ons

Get addon installable data
Create addon link
Invoke addon link
Delete addon link

Capabilities

Get capabilities

Emoticons

Get emoticon
Get all emoticons

OAuth Sessions

Generate token
Get session
Delete session

Rooms

Get all rooms
Create room
Get room
Update room
Delete room
Get avatar
Update avatar
Delete avatar
Get room message
View room history
View recent room history
Invite user
Add member
Remove member
Get all members
Send message
Send room notification
Get all participants
Reply to message
Share file with room
Get room statistics
Set topic
Get webhook
Delete webhook
Get all webhooks
Create webhook

Users

Get all users
Create user
View user
Update user
Delete user
Get privatechat message
View recent privatechat history
Private message user
Get photo
Upload photo
Delete photo
Get auto join rooms
Share file with user
Share link with user

gorkalaucirica / hipchat-v2-api-client

Maintainers

Details