Ready to use libraries

PHP tarpipe client
more soon..

API 2.0

Obtaining a consumer key and secret
Accessing the API endpoint
Security
Available methods
Error responses
Support

Obtaining a consumer key and secret

To start using our available methods you first need to register your application and obtain a consumer key and secret. During an early phase we'll be screening all application requests. Please if you're interested in using our API.

Accessing the API endpoint

The API is listening on http://api.tarpipe.net/2.0/. To execute a method add the method's path to this URL.

Whenever invoking HTTP POST methods make sure that you're using the multipart/form-data encoding type, either by using the -F curl option or by defining it in your code. Here's an example using PHP's cURL library:

$ch = curl_init('http://example.com/');
$params = array('title' => 'test title');
curl_setopt($ch, CURLOPT_POSTFIELDS, $params);

Just make sure that $params is an array.

Security

Applications should receive authorization using the OAuth protocol. This API complies to a subset of the OAuth Core 1.0 Standard and provides the following endpoints:

Request token URL: http://tarpipe.com/oauth/request_token/
User authorization URL: http://tarpipe.com/oauth/authorize/
Access token URL: http://tarpipe.com/oauth/access_token/

All requests to the API methods must be using HMAC-SHA1 signatures.

We suggest that you use one of the available OAuth libraries for your favorite programming language. You can also use Jon Crosby's excellent Endpointr application if you want to test our API methods.

Because some of our methods receive the payload on a multipart/form-data HTTP POST, we suggest that you send the OAuth protocol parameters in the HTTP Authorization header as defined in OAuth HTTP Authorization Scheme.

Available methods

The API follows the RESTful approach and all the responses comply to the REST response schema.

`/workflow/start/<id>`

Starts the REST workflow defined by id. The workflow must already exist.

To invoke this method, send an HTTP POST to its endpoint.

The response is an XML document containing the result code and the transaction identifier (tid). The tid can be used later on to obtain information about this transaction's activity (see also /activity/workflow/<tid>).

Example response:

<?xml version="1.0"?>
<restResponse code="200">
  <item>
    <var name="tid" value="5D0937A38DFE6F5C32C6024C8E896AC5"/>
  </item>
</restResponse>

`/workflow/adhoc/start`

Starts the workflow provided on the request.

To invoke this method, send an HTTP POST to its endpoint. You specify the workflow by sending an XML definition through the _workflow POST field. The contents of the _workflow field must comply to the workflow schema.

Example _workflow contents:

<?xml version="1.0"?>
<workflow version="1.0">
  <head>
    <title/>
    <description/>
    <owner/>
    <receptor/>
  </head>
  <body>
    <step id="1" connector="TwitterUpdater">
      <input>
        <var name="title" field="title"/>
      </input>
    </step>
  </body>
</workflow>

Example response:

<?xml version="1.0"?>
<restResponse code="200">
  <item>
    <var name="tid" value="5D0937A38DFE6F5C32C6024C8E896AC5"/>
  </item>
</restResponse>