Giter Club home page Giter Club logo

slack's Introduction

Slack API library Software License

Access your Slack Team's API through PHP objects.

Build Status Coverage Status Quality Score Latest Version Total Downloads

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)

Further reading

I've done my best to include links to the official documentation in the code where appropriate.

Still, you should really check out the API documentation of Slack yourself to get a better understanding of exactly what each API method does and what data it will return.

If you feel there is some part of this package that you would like to see documented in more detail, please don't hesitate to create an issue for it.

Contributing

Got a good idea for this project? Found a nasty bug that needs fixing? That's great! Before submitting your PR though, make sure it complies with the contributing guide to speed up the merging of your code.

Missing methods

The following methods have not yet been implemented, why not contribute and add some yourself?

  • files.delete*
  • pins.add
  • pins.list
  • pins.remove
  • reactions.add
  • reactions.get
  • reactions.list
  • reactions.remove
  • team.accessLogs
  • team.info

* = issue/PR has been opened for this method

Related packages

  • Slack CLI - CLI application for all of the Slack API methods.
  • SlackBundle - Symfony Bundle providing integration with this library package.

Attributions

  • The Slack staff, for making an awesome product and very clean API documentation.

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.

slack's People

Contributors

cleentfaar avatar agentsib avatar carsso avatar n1c avatar hashnz avatar adrienbrault avatar arendjantetteroo avatar nousefreak avatar ballisticpain avatar mathielen avatar stefanbraspenning avatar salt-lick avatar nyholm avatar zxurian avatar

Watchers

James Cloos avatar Radoaslav Nedyalkov avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.