docs.akkroo.com
Testing the API
http://docs.akkroo.com/developers/api/endpoints/tests
We offer two simple tests to check that you can connect to the API. The Self Test allows you to check that you’re hitting the API and getting a response. The Authentication Test allows you to check that your access token is correct. This API endpoint allows you to test if the API is alive, and you’re able retrieve a simple response. GET https:/ akkroo.com/api/selftest. HTTP/1.1 200 OK Content-Type: application/vnd.akkroo-v1.1.4 json { "success" : true }. Booelan either true or false.
docs.akkroo.com
List of API Errors
http://docs.akkroo.com/developers/api/errors
There are two formats of error you can receive from the API:. OAuth 2 authentication errors. OAuth 2 Error Codes. Akkroo Authorisation Error Codes. Field Validation Error Types. OAuth errors are used as described in OAuth 2 (RFC 6749). The response body is a JSON document in the following format:. OAuth 2 error codes. These are the errors used in error . The authenticated client is not authorized to use this authorization grant type. Akkroo authorisation error codes. The access token provided was invalid.
docs.akkroo.com
About versions of the API
http://docs.akkroo.com/developers/api/versioning
The current API version is 1.1.4. API version numbering follows the pattern defined in Semantic Versioning v2.0.0. Any minor versions will be backwards compatible. Only major releases will include breaking changes. For Akkroo, this does not mean that the output or expected input of a minor update will be exactly the same as the previous version, but that the API will still support previous versions for request and response. Header), and the API response versions your application can handle (. HTTP/1....
docs.akkroo.com
Using Webhooks with Akkroo
http://docs.akkroo.com/developers/webhooks
Understanding and Using Webhooks. Webhooks are a way to let Akkroo to call a script or send some data to your own web server when a person registers at an event or when payload is captured. An example of how this might be useful is as follows,. A person arrives at an event and registers onto the guestlist. Akkroo sends a payload to a URL on your website, letting you instantly create a user account for that person. Other uses could include:. Updating a live statistics display in your office. The action th...
docs.akkroo.com
Working with Events in the API
http://docs.akkroo.com/developers/api/endpoints/events
Events define what questions are asked of the end user and the data required from them, and contain a collection of registrations. Https:/ akkroo.com/api/events/ id. Name" : "Oxford Questionnaire" }. Name of the event. Type" : 1 }. Type of event. See the list of event types. Status" : 1 }. Default) — active. Date : "2013-06-19" }. Start date of the event in the format YYYY-MM-DD. Questions" : }. The definitions of any questions asked at the event, presented in an array. Read the Questions Definition.
docs.akkroo.com
List of API Endpoints
http://docs.akkroo.com/developers/api/endpoints
An event contains a list of questions, and the answers and details collected (‘registrations’). Access or store user and question data collected at an event. Access the events and information that belong to a specific ‘company’ account. Useful for checking API connectivity in production environments.
docs.akkroo.com
Working with Event Types in the API
http://docs.akkroo.com/developers/api/endpoints/events/types
Check-in then Data Capture (no Registration). Check-in or Register then Data Capture.
docs.akkroo.com
Working with Companies in the API
http://docs.akkroo.com/developers/api/endpoints/company
Company is a model-only endpoint you cannot access a collection of companies, only the company associated with your access token. Name": "Wexler Inc." }. The name of the company. The username of the company. This is the username used for logging in to the App. Date in format YYYY-MM-DD. The account expires at midnight at the start of the day. The number of individual devices active in the last 2 weeks. LastModified": "Thu, 26 Sep 2013 11:45:22 GMT" }. Created": "Mon, 07 Oct 2013 11:42:34 GMT" }.
docs.akkroo.com
Authentication with the API
http://docs.akkroo.com/developers/api/authentication
The API endpoints require an access token in the. Header of every request. You can generate this token using a ‘Client Credentials’ grant http:/ tools.ietf.org/html/rfc6749#section-4.4. This is a simple process - you use the Client Credentials found in your account dashboard, then you perform a POST to the authorization endpoint, which will return your access token on success. You can find your Client Credentials. POST https:/ akkroo.com/api/auth. Grant type": "client credentials". You need to store both...
SOCIAL ENGAGEMENT