README

   _____ _            _
  / ____| |          | |
 | (___ | | __ _  ___| | __
  \___ \| |/ _` |/ __| |/ /
  ____) | | (_| | (__|   <
 |_____/|_|\__,_|\___|_|\_\

Access your Slack Team's API through PHP objects.

This package has been adapted from cleentfaar/slack by H&H|Digital, an Australian botique developer. Visit us at hnh.digital.

1.0.0 release

Please note that from the 1.0.0 release this package's namespace (and folder structure) will change from CL\Slack to HnhDigital\SlackApi.

From v1.0.0 all the payloads and responses will be matched with the Slack API and missing api methods (listed below) will be completed.

Documentation

Getting started - Before you use this library, you need to generate a token or setup oAuth.
Installation - Information on installing this library through composer or as a git submodule.
Usage - A few simple examples on how to access the Slack API using this library
API methods - Detailed information on each of Slack's API methods and how to access them using this library's Payload classes.
Events - Examples for listening to events fired by the ApiClient

Features

Access all of Slack's API methods with dedicated payload classes (see usage documentation)
Payloads and responses follow the same definitions as described in the official documentation (with a few exceptions where I think it would make a better distinction).
Data between you and Slack is serialized using the JMS Serializer package, allowing fully spec-ed PHP objects to be used for working with the API.
Code has been highly abstracted to support re-use in more specific implementations (see SlackBundle)

Unit testing

Currently unit testing is broken (as per imported repo cleentfaar/slack). This will be updated to the latest version shortly.

Feel free to fix with a PR.

Up-to-date methods

The following methods have been reviewed and updated:

chat.postMessage (Last reviewed: June 23, 2017)
chat.update (Last reviewed: June 23, 2017)
oauth.access (Last reviewed: June 21, 2017)
users.identity (Added: June 25, 2017)

Feel free to review a method and update the README with a PR.

Missing API methods

The following methods have not been implemented.

Feel free to add a PR.

auth.revoke
channels.replies
chat.meMessage
chat.unfurl
dnd.endDnd
dnd.endSnooze
dnd.setSnooze
dnd.teamInfo
files.comments.add
files.comments.delete
files.comments.edit
files.delete
files.revokePublicURL
files.sharedPulbicURL
im.replies
mpim.close
mpim.history
mpim.list
mpim.mark
mpim.open
mpim.replies
pins.add
pins.list
pins.remove
reactions.add
reactions.list
reactions.remove
reminders.add
reminders.complete
reminders.delete
reminders.info
reminders.list
rtm.connect
stars.add
stars.remove
team.accessLogs
team.billableInfo
team.integrationLog
team.profile.get
usergroups.create
usergroups.disable
usergroups.enable
usergroups.list
usergroups.update
usergroups.users.list
usergroups.users.update
users.deletePhoto
users.setPhoto
users.profile.get
users.profile.set

Methods that need removing

The following methods no longer exist in the API:

users.adminInvite

Related packages

Slack for Laravel - Laravel integration with this library package.

FAQ

Why am I getting a cURL 60 error when attempting to connect to the Slack API?

Under the hood this library uses Guzzle to connect to the Slack API, and Guzzle's default method for sending HTTP requests is cURL.

The full error code is CURLE_SSL_CACERT: Peer certificate cannot be authenticated with known CA certificates and may be due, especially on Windows or OS X, to Guzzle not being able to find an up to date CA certificate bundle on the operating system.

To fix this you first create the Guzzle client manually using an alternative CA cert bundle, or disabling peer verification (not recommended for security reasons), and pass it to the API Client.

$client = new \GuzzleHttp\Client();
$client->setDefaultOption('verify', 'C:\Program Files (x86)\Git\bin\curl-ca-bundle.crt');

// continue as normal, using the client above

$apiClient =  new ApiClient('api-token-here', $client);

If you get a different error code you can look at the list of cURL error codes, or consult the Guzzle documentation directly.

hnhdigital-os / php-slack-api

Maintainers

Details