PHPackages                             echo-five/sparky-api-client-php - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. echo-five/sparky-api-client-php

ActiveLibrary[API Development](/categories/api)

echo-five/sparky-api-client-php
===============================

Sparky API Client PHP

v1.0.0(5mo ago)03MITPHPPHP >=8.3

Since Nov 22Pushed 5mo agoCompare

[ Source](https://github.com/echo-five/sparky-api-client-php)[ Packagist](https://packagist.org/packages/echo-five/sparky-api-client-php)[ Docs](https://github.com/echo-five/sparky-api-client-php)[ RSS](/packages/echo-five-sparky-api-client-php/feed)WikiDiscussions main Synced 1mo ago

READMEChangelogDependenciesVersions (2)Used By (0)

Sparky API Client PHP
=====================

[](#sparky-api-client-php)

[![PHP Version](https://camo.githubusercontent.com/9bf67f86d575c87bf6c023686d5e5a831f629a94a3bac355486e709814df4648/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f5048502d382e332532422d3737374242343f7374796c653d666c61742d737175617265266c6f676f3d706870266c6f676f436f6c6f723d7768697465)](https://camo.githubusercontent.com/9bf67f86d575c87bf6c023686d5e5a831f629a94a3bac355486e709814df4648/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f5048502d382e332532422d3737374242343f7374796c653d666c61742d737175617265266c6f676f3d706870266c6f676f436f6c6f723d7768697465) [![Size](https://camo.githubusercontent.com/ca8bd39af3ca0d131bda199cc8e3abf8c92f637eacd08e7af9f5c127e6463dc8/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6c616e6775616765732f636f64652d73697a652f6563686f2d666976652f737061726b792d6170692d636c69656e742d7068703f6c6162656c3d53697a65267374796c653d666c61742d737175617265)](https://camo.githubusercontent.com/ca8bd39af3ca0d131bda199cc8e3abf8c92f637eacd08e7af9f5c127e6463dc8/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6c616e6775616765732f636f64652d73697a652f6563686f2d666976652f737061726b792d6170692d636c69656e742d7068703f6c6162656c3d53697a65267374796c653d666c61742d737175617265) [![License](https://camo.githubusercontent.com/3bf3307f7f64f3d0f8f840e61fd74d5e3146837fd3243a58f4d58641d36f930c/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6c6963656e73652f6563686f2d666976652f737061726b792d6170692d636c69656e742d7068703f6c6162656c3d4c6963656e6365267374796c653d666c61742d737175617265)](https://github.com/echo-five/sparky-api-client-php/blob/master/LICENSE)

A PHP client library for the Sparky API.

Menu
----

[](#menu)

- [Requirements](#requirements)
- [Installation](#installation)
    - [How to install?](#how-to-install)
    - [How to update?](#how-to-update)
    - [How to remove?](#how-to-remove)
- [Get started](#get-started)
- [Features](#features)
    - [Simple request vs Signed request](#simple-request-vs-signed-request)
    - [Debugging](#debugging)
- [Available methods](#available-methods)
    - [Request](#request)
    - [Get Response](#get-response)
    - [Get Response Status](#get-response-status)
    - [Get Response Headers](#get-response-headers)
    - [Get Response Data](#get-response-data)
    - [Get Response Messages](#get-response-messages)
    - [Get Sent](#get-sent)
    - [Get Sent Headers](#get-sent-headers)
    - [Get Sent Payload](#get-sent-payload)
    - [Get cURL Info](#get-curl-info)
    - [Debug Start](#debug-start)
    - [Debug Stop](#debug-stop)
    - [Debug Get](#debug-get)
    - [Debug Reset](#debug-reset)
    - [Accept Unsafe Certificates](#accept-unsafe-certificates)
- [License](#license)

Requirements
------------

[](#requirements)

PHP 8.3 or higher with cURL, JSON, Sodium and Ctype extensions

Installation
------------

[](#installation)

### How to install?

[](#how-to-install)

This package can be installed via Composer:

```
composer require echo-five/sparky-api-client-php
```

### How to update?

[](#how-to-update)

Use the following command to update this package only:

```
composer update echo-five/sparky-api-client-php
```

### How to remove?

[](#how-to-remove)

This package can be uninstalled via Composer:

```
composer remove echo-five/sparky-api-client-php
```

Get started
-----------

[](#get-started)

Prerequisites

- The library has been installed via Composer.
- You have a valid API Key.
- You have a valid API Signature Key (to "sign" the request, see [here](#simple-request-vs-signed-request)).

Create a new blank PHP file and copy the code below:

```