API Reference

Tessera provides a read-only API for you to extract information from its database.

Your API license key can be found in the Info tab of your Tessera admin panel. You should keep this license key a secret, as it can be used to read sensitive information without logging in to your panel.

By default, API access is disabled. You must first enable API access as a plugin in your Tessera admin panel.

To communicate with the API, you need only send basic https requests according to the schema:

https://[COMPANY].tessera.events/api/[LICENSEKEY]/[OBJECT]/[OPERATION]/[IDENTIFIER]

• All responses from the API are encoded with JSON.

• Monetary amounts are given in pounds, and dates in the format Wed 30 Nov 2016 19:30.

• Any URL responses given are escaped, and so should be run through something similar to json_decode() for use.

Error Handling

The Tessera API is as fail-safe as possible. In the event of a bad request, the response shall be a JSON string encoding an array with one key, error, its value a human-readable description of the failure.

You have not enabled API access for this company

API access is disabled by default. You must first enable it by turning on the API plugin in your Tessera panel.

Please sign all requests with your license key

Please check the license key matches that in your Tessera panel. License keys are case sensitive.

Query not supported

You have entered a bad request. Please check the documentation for instructions on correct syntax.

No [OBJECT]

The request was valid but you do not have any objects to show yet.

No [OBJECT] in scope

The request was valid but you do not have any objects to show for this search yet.

Could not find

You performed a get operation on an object identifier which cannot be found in the database. Records are kept even when objects are deleted from the Tessera panel. Check the identifier is correct.

Rate limit exceeded

You performed more queries than we would reasonably expect in the past 15 minutes. Wait and try later.

API down for maintenance

It's us, not you. Please wait and try later.

Getting Started

We do not distribute a package for the Tessera API but rather expect you to create your own HTTPS requests.

Some ideas to get you on the right track:

• For Python, see urllib documentation and the json module.

• For PHP5, it is very easy to use cURL and json_decode().

• For Ruby, try the OpenURI module and the json #parse method.