curl-client-setup.md

GOV.UK Notify - PHP Client with Curl

PSR-7 HTTP

The Notify PHP Client is based on a PSR-7 HTTP model. You therefore need to pick your preferred HTTP Client library to use.

This shows how to setup the GOV.UK Notify using Curl.

Installing

The Notify PHP Client can be installed with Composer. Run this command:

composer require php-http/curl-client php-http/message alphagov/notifications-php-client

Usage

Assuming you've installed the package via Composer, the Notify PHP Client will be available via the autoloader.

Create a Curl client based instance of the Client using:

$notifyClient = new \Alphagov\Notifications\Client([
    'serviceId'     => '{your service id}',
    'apiKey'        => '{your api key}',
    'httpClient'    => new \Http\Client\Curl\Client(
        new \Http\Message\MessageFactory\GuzzleMessageFactory,
        new \Http\Message\StreamFactory\GuzzleStreamFactory
    ),
]);

You are then able to access the Notify API using $notifyClient.

If you need to access an environment other than production, you can pass the base URL in via the baseUrl key in the constructor:

'baseUrl' => '{api base url}'

All remaining usage is as per the README.