Download the PHP package tunr/slimsurveys-api-php without Composer
On this page you can find all versions of the php package tunr/slimsurveys-api-php. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download tunr/slimsurveys-api-php
More information about tunr/slimsurveys-api-php
Files in tunr/slimsurveys-api-php
Package slimsurveys-api-php
Short Description A REST client for the SlimSurveys API.
License
Informations about the package slimsurveys-api-php
SlimSurveys API PHP Client
SlimSurveys is a micro-survey platform to help people improve survey completion and abandonment rates with surveys that can be completed in 30 seconds or less.
This repository contains a PHP client library to interface with the SlimSurveys API.
API Key
First things first, visit the SlimSurveys site to request an API key.
https://slimsurveys.com/developer
Installation
Require the SlimSurveys client in your composer.json
file.
Then run composer install
to get the code and update your autoloader.
Create the Client
Now with your trusty API key, create a client instance.
API methods can then be called on the client instance.
Authentication
Just passing an API key to the client constructor will only get you so far as most API requests require an authentication token. With your SlimSurveys user account email and password you can request an authentication token like so...
Currently an authentication token doesn't expire so it can be stored and used for multiple requests. Once you have a token, it can be passed to the client through the constructor.
You can also use a token setter to pass a token to an existing client if it was not available when the client was created.
Response
The following methods can be used to inspect the response from an API method.
Example:
Data
The data getter allows you to return a formatted version of the JSON data returned by the SlimSurveys API. Data is returned as an object by default, but can be returned as an associative array by passing true
to the data getter.
Debugging
Since the entire client instance is returned by each API method, a simple var_dump($response)
will provide some visibility into how an API request is configured.
API Methods
The following API methods are available. They're listed in the same order as the API documentation so you can easily match up the methods to the official docs.
Authentication
Answers
Identities
Images
Options
Questions
Results
Surveys
Users
Requirements
- PHP 5.3+
- cURL
Note: A version of PHP < 5.3 will work if class prefixing is used instead of namespacing.