RapidSpike API Wrapper (PHP)
PHP wrapper for the RapidSpike API (v1)., (*1)
RapidSpike provides a RESTful API designed to make interfacing with their services cleaner and easier. The RapidSpike Portal is 100% API powered so anything you can do there is possible directly via the API., (*2)
To interact with the API you must first have a RapidSpike subscription that allows access to the API. Then you need to generate API keys in your account settings area., (*3)
This wrapper package is future proof as new end-points become available - it is merely a wrapper that provides a standardised way to construct end-points, package request data and authenticate in the API., (*4)
Installation
Recommended installation is via Composer and Packagist. Check the available version tags, however, development won't be overly active due to to nature of the package., (*5)
composer require rapidspike/rapidspike-api-wrapper-php
Concepts
End-point Chaining
This wrapper package is very simple, but provides you with a standard way to call our API. End-points are built using a function-per-path segment or directly in the callPath() method. This makes use of magic methods so that we're future proofed against new end-points., (*6)
/*
* Read account API keys
* GET /accounts/api
*/
# Function-per-path method
$Client->accounts()->api()->via('get');
#Â callPath() method
$Client->callPath('accounts/api')->via('get');
If you need to add a value that doesn't fit into this method or is stored in a variable then the callPath() method is better and saves your from having to declare dynamic function names. Also, segments can be passed as parameters to segment methods:, (*7)
/*
* Read one website
* GET /websites/[uuid]
*/
#Â Segment (UUID) stored in varibale and passed as function param
$uuid = '30031b9b-5df8-4b19-8dfe-17bf5bac7654';
$Client->websites($uuid)->via('get');
All requests must end by calling the via() method and passing an HTTP request verb (e.g. get, post, put, delete). Authentication is made using a pair of keys (public and private) that are required to generate a signature which is checked in the RapidSpike API., (*8)
Query & JSON Data
Adding query or JSON data can be done in or before the method chain. Either way it must be done before the via() method:, (*9)
/*
* Read page 1 of all websites with 10 displayed per page
*/
#Â Add query data before the actual request is made
$Client->addQueryData(['page' => 1, 'per_page' => 10]);
$Client->websites()->via('get');
# Alternative; add query data whilst building the request
$Client->websites()->addQueryData(['page' => 1, 'per_page' => 10])->via('get');
Usage example
Usage begins with instantiating the RapidSpike\API\Client object and passing your public and private keys, which are required. From there you have a number of options on how to build the end-point (see Concepts above)., (*10)
<?php
include 'vendor/autoload.php';
# Instantiate the Client with authentication keys
$Client = new RapidSpike\API\Client("rapidspike-********", "**********************************************");
# Add paging query data to be turned into the query string
$Client->addQueryData(['page' => 1, 'per_page' => 10]);
# Read all websites
$Websites = $Client->websites()->via('get');
# Read the first website's stats by its UUID
$uuid = $Websites->data->websites[0]->website->uuid;
$Website = $Client->websites($uuid)->addQueryData(['stats' => 'status,average_response,passing_monitors,failing_monitors,total_monitors'])->via('get');
Twitter: @rapidspike, (*11)
Wallogit.com
