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.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of rapidspike/rapidspike-api-wrapper-php

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

All versions of rapidspike-api-wrapper-php with dependencies

PHP Build Version
Package Version
Requires php Version >=7.0.0
guzzlehttp/guzzle Version ~6.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package rapidspike/rapidspike-api-wrapper-php contains the following files

Loading the files please wait ....