Introduction

The RESTful API allows developers to build applications using take.io’s communication services in a platform-agnostic format, using simple and secure HTTP calls. It’s very easy to write and test applications: you can even use your browser to access URLs, and you can use pretty much any HTTP client in any programming language to interact with the API, such as Flash, PHP, Java, JavaScript, .NET, and others.

The take.io RESTful API currently defines five services: SSO, Core, Billing, Messages and Reports. Each service represents a set of entities involved in a communications interaction, and can be referenced using specific URIs. REST uses URIs to identify resources involved in a particular interaction.

For example, https://api.take.io/rest/1.0/core/people is an URI that have access to the platform users. The URI is the identifier and the resulting list of users is the resource.

Resources can be updated, added, or deleted by sending representations from the client to the server. Access to resources occurs through the HTTP interface. HTTP provides four basic methods for the following operations:

  • Retrieve information about a resource: HTTP/GET
  • Create a new resource: HTTP/POST
  • Modify an existing resource: HTTP/PUT
  • Delete an existing resource: HTTP/DELETE

Base URL

All URLs referenced in the current documentation have the following base:

https://api.take.io/rest/1.0/

HTTP and HTTPS

The take.io REST API is served over HTTPS. To ensure data privacy unencrypted HTTP is discouraged.