The Temboo REST API allows you to make HTTP requests to perform a variety of CRUD operations. The REST API includes methods to:
At a high level, HTTP GET requests are used to retrieve information from the API, such as Choreo IDs, whereas HTTP POST requests are used to execute Choreos. All API actions return XML or JSON data. cURL code snippets are available from the Library to show how you can use the REST API directly.
No matter what operation you're performing, each request you make to the Temboo REST API must include the following:
The required Temboo Domain request header should be in the format:
For example, if your Temboo account name is "FooCorp", you should send the following domain header:
The Temboo REST API uses HTTP Basic authentication to verify your credentials. When your application makes a request to the API, you must include an "Authorization" header containing a valid Temboo username and password.
Note: your application name and application key can be used in place of your username and password.
The HTTP Basic authentication format requires that you construct a string consisting of <username>:<password> (or <app_name>:<app_key>) and then Base64 encode the string before transmitting it as the value of the "Authorization" header. For example, if your username is "Aladdin" and your password is "open sesame", your HTTP Basic authentication string would be:
The value of this string would then be Base64 encoded to "QWxhZGRpbjpvcGVuIHNlc2FtZQ==" and transmitted in an HTTP header in the format:
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
Each request to the Temboo API must contain an "Accept" header indicating the type of response your client expects, and a "Content-Type" header indicating the format in which the request is being sent. For both headers, the possible values are:
The name of your Temboo account is passed in the URLs of HTTP requests made to the API. Here's the general format of API URLs:
For example, if your subscription name is "FooCorp" and you want to retrieve a list of available Choreos, your request URL is:
Note: All requests to the Temboo API must be made via the HTTPS protocol to keep your information secure.
The following table shows the basic set of supported API actions. Detailed information on each action can be found here.
|List available Choreos||GET||/choreos/<id>||No additional parameters needed|
|List specific Choreo details||GET||/choreos/<id>||Where <id> is the identifier for a specific Choreo, returned by the /choreos action|
|Execute a Choreo||POST||/choreos/<id>||Where <id> is the identifier of the Choreo to run; input values can optionally be provided in the POST body|
|List currently running Choreos||GET||/choreo-executions||No additional parameters needed|
|List details for a specific Choreo execution||GET||/choreo-executions/<id>||Where <id> is the identifier for a specific execution, returned by the /choreo-executions action|
|Terminate a running Choreo||DELETE||/choreo-executions/<id>||Where <id> is the identifier for a specific execution, returned by the /choreo-executions action|
Now you're ready to run any of our 2000+ Choreos using the REST API. You're just a few steps away from making something extraordinary.
We're always happy to help. Just email us at firstname.lastname@example.org, and we'll answer your questions.