Download the PHP package rapidspike/rapidspike-api-wrapper-php without Composer
On this page you can find all versions of the php package rapidspike/rapidspike-api-wrapper-php. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download rapidspike/rapidspike-api-wrapper-php
More information about rapidspike/rapidspike-api-wrapper-php
Files in rapidspike/rapidspike-api-wrapper-php
Package rapidspike-api-wrapper-php
Short Description PHP wrapper functions for interfacing with RapidSpike's API.
License MIT
Informations about the package rapidspike-api-wrapper-php
RapidSpike API Wrapper (PHP)
PHP wrapper for the RapidSpike API (v1).
Information
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.
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.
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.
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.
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.
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:
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.
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:
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).
Contact
Twitter: @rapidspike