Skip to content
Jim Mullen edited this page Feb 21, 2016 · 1 revision

Welcome to the sendgrid-webapi-v3-php wiki!

What's this repo for?

This repo is a PHP client for SendGrid's WebAPI v3. It is important to note that SendGrid has a few different API's and even has two different versions of their WebAPI...specifically v2 and v3. This PHP client is for v3 only.

Why should I use this PHP client for the SendGrid WebAPI v3?

SendGrid does have their own PHP client. At the time we started writing our PHP client, we found that their client lacked certain features and due to the architecture of their client, it did not appear that they would be able to easily implement some of these features down the line. So, we started writing our own PHP client for their WebAPI v3 which was very structured and started with the very basics such as Authentication and handling response data. We also worked hard to make the ability to switch out the HTTP client (Guzzle, in our case) so that if Guzzle (or even the version of Guzzle we chose) did not suit your needs, you could fairly easily replace it with your own choice of HTTP client.

We strive to...

  • make this PHP client implement all of the features available as documented in SendGrid's WebAPI v3 documentation
  • make this PHP client very structured, object-oriented and well tested.

Who can contribute?

Anyone is welcome to fork our repo and submit pull requests. We just ask you follow a couple rules for pull requests:

  1. Follow the PSR-2 coding standards.
  2. Add DocBlocks for all class properties and methods.
  3. Write unit tests for any code contributions to show that it works as expected.

I have questions, suggestions, comments, etc. How can we communicate?

Communication is the best way for everyone to learn and be involved. We've setup a HipChat room that everyone is invited to join and get involved in the conversation. Its free so join in. Jim Mullen is the moderator for iDimensionz and will be glad to answer any questions when he's online.

This wiki is a work in progress. We already have a couple additional contributors and welcome contributions to help build out the rest of this API client.