Overview

This is an experimental API. We're excited to share it, but it's a very new feature that is in flux, and we're also still learning if this is the right approach.

The Active in Time (AIT) API is another way to access your AIT data — one that makes it easy for third-party tools to interact with the service. The API follows the REST conventions. This guide should provide everything you need to implement software that works with AIT.

The Terms of Service covers the acceptable use of the service and API. Beyond the legalities, please design your programs to use AIT considerately — clients are expected to conform to HTTP 1.1, cache as much as possible, limit the frequency of requests, and include a User-Agent header. If you don't do this you may find yourself blacklisted. If you find a problem with the service or API, please give us a chance to correct it before going public. If you have any questions or issues, feel free to contact Dan.

For general questions, announcements, and discussion about the API, please use the Active in Time LinkedIn Group. For direct contact, email Dan.

Authentication

All authentication is handled via your API Key. To protect your API key this must remain private and the request must be sent over the https:// protocol.

Rate Limiting

We reserve the right to rate limit any API Client who is abusing the service. Conforming to HTTP 1.1 and caching as much as possible whilst limiting the frequency of requests will keep you in our good books.

Responses and Errors

All response codes are included in the Meta tag in the top of the response. Possible status codes include:

  • 200: Success (upon a successful GET, PUT, or DELETE request)
  • 400: Resource Invalid (improperly-formatted request)
  • 403: Forbidden (incorrect or missing authentication credentials)
  • 404: Resource Not Found (invalid API end point.)
  • 500: Application Error