# Client libraries
GC Notify (opens new window) was based on the UK government's notification system. Therefore, the API is also available using the clients developed by GOV.UK (opens new window).
# Before integrating the API
You will need to change the API endpoint when creating a client.
import uk.gov.service.notify.NotificationClient;
NotificationClient client = new NotificationClient(apiKey, "https://api.notification.canada.ca");
using Notify.Client;
var client = new NotificationClient("https://api.notification.canada.ca", apiKey);
require __DIR__ . '/vendor/autoload.php';
$notifyClient = new \Alphagov\Notifications\Client([
'baseUrl' => "https://api.notification.canada.ca",
'apiKey' => 'your-api-key',
'httpClient' => new \Http\Adapter\Guzzle6\Client
]);
NotifyClient("https://api.notification.canada.ca", apiKey)
from notifications_python_client.notifications import NotificationsAPIClient
notifications_client = NotificationsAPIClient(
api_key,
base_url="https://api.notification.canada.ca"
)
require 'notifications/client'
client = Notifications::Client.new(api_key, "https://api.notification.canada.ca")
// Make sure to add code blocks to your code group
Feature differences to keep in mind
- Sending files by email is different with GC Notify
- Sending bulk notifications through the GOV.UK Notify clients is not directly supported. You can still use one if the client supports customization of the URL endpoint
- Sending letters is not available
- Receiving text messages is not available