Quickly and easily access any RESTful or RESTful-like API.
If you are looking for the SendGrid API client library, please see this repo.
Announcements
The default branch name for this repository has been changed to main as of 07/27/2020.
All updates to this library are documented in our CHANGELOG.
Table of Contents
Installation
Prerequisites
- PHP version 5.6, 7.0, 7.1, 7.2, 7.3, or 7.4
Install with Composer
Add php-http-client to your composer.json file. If you are not using Composer, you should be. It's an excellent way to manage dependencies in your PHP application.
{
"require": {
"sendgrid/php-http-client": "^3.14.4"
}
}
Then at the top of your PHP script require the autoloader:
require __DIR__ . '/vendor/autoload.php';
Then from the command line:
composer install
Install without Composer
You should create a lib directory in the directory of your application and clone to lib repositories php-http-client and sendgrid-php:
$ cd /path/to/your/app
$ mkdir lib
$ cd lib
$ git clone https://github.com/sendgrid/php-http-client.git
In the next step you should create loader.php:
$ cd /path/to/your/app
$ touch loader.php
And add the code below to the loader.php:
require_once __DIR__ . '/lib/php-http-client/lib/Client.php';
require_once __DIR__ . '/lib/php-http-client/lib/Response.php';
After it you can use the php-http-client library in your project:
include __DIR__ . '/loader.php';
$client = new SendGrid\Client();
Quick Start
Here is a quick example:
GET /your/api/{param}/call
// include __DIR__ . '/loader.php';
require 'vendor/autoload.php';
$apiKey = YOUR_SENDGRID_API_KEY;
$authHeaders = [
'Authorization: Bearer ' . $apiKey
];
$client = new SendGrid\Client('https://api.sendgrid.com', $authHeaders);
$param = 'foo';
$response = $client->your()->api()->_($param)->call()->get();
var_dump(
$response->statusCode(),
$response->headers(),
$response->body()
);
POST /your/api/{param}/call with headers, query parameters and a request body with versioning.
// include __DIR__ . '/loader.php';
require 'vendor/autoload.php';
$apiKey = YOUR_SENDGRID_API_KEY;
$authHeaders = [
'Authorization: Bearer ' . $apiKey
];
$client = new SendGrid\Client('https://api.sendgrid.com', $authHeaders);
$queryParams = [
'hello' => 0, 'world' => 1
];
$requestHeaders = [
'X-Test' => 'test'
];
$data = [
'some' => 1, 'awesome' => 2, 'data' => 3
];
$param = 'bar';
$response = $client->your()->api()->_($param)->call()->post($data, $queryParams, $requestHeaders);
var_dump(
$response->statusCode(),
$response->headers(),
$response->body()
);
If there is an issues with the request, such as misconfigured CURL SSL options, an InvalidRequest will be thrown with message from CURL on why the request failed. Use the message as a hit to troubleshooting steps of your environment.
Usage
Environment Variables
You can do the following to create a .env file:
cp .env_example .env
Then, just add your API Key into your .env file.
How to Contribute
We encourage contribution to our libraries, please see our CONTRIBUTING guide for details.
Quick links:
Thanks
We were inspired by the work done on birdy and universalclient.
About
php-http-client is maintained and funded by Twilio SendGrid, Inc. The names and logos for php-http-client are trademarks of Twilio SendGrid, Inc.
If you need help installing or using the library, please check the Twilio SendGrid Support Help Center.
If you've instead found a bug in the library or would like new features added, go ahead and open issues or pull requests against this repo!
2 Nov 19, 2021
2 Nov 19, 2021
2 Aug 26, 2022
5 Dec 15, 2022
63 Feb 14, 2022
6 Jun 14, 2023
3 Sep 10, 2022
4 Jul 25, 2022
665 Dec 23, 2022
2k Jan 7, 2023
5 Feb 24, 2022
96 Jan 6, 2023
52 Dec 23, 2022
4 Nov 17, 2022
6 Sep 14, 2022
1.1k Dec 22, 2022
3 Dec 22, 2022
4 Oct 3, 2022
1 Oct 26, 2021