This operation retrieves a list of signatures/documents from the Infinity Cloud service. Data can be filtered and offset ranges can be applied to allow for pagination in your end-use.
HTTP POST
To request a list of signatures/documents, make an HTTP POST to the API:
https://www.infinitysignature.com/api/v1/
Parameter | Req. | Value | Description |
---|---|---|---|
key | yes | api key | Supply the API key for your Infinity Cloud account. |
format | no | “json” | “xml” | Specify the requested format of return data. Defaults to json. |
task | yes | “siglist” | The task determines the type of request being made to the API. |
offset | no | integer | Number of records to skip when returning results. The offset is used to facilitate user-end pagination. |
limit | no | integer | Number of records to return. The limit is used to facilitate user-end pagination. |
reference | no | string | The reference number or value supplied when publishing to the cloud server from the Infinity Signature Capture app. |
ref_partial | no | boolean | Set to true to allow partial text matches for reference lookup. Defaults to false. |
Example
Retrieve a list of the 20 most recent signatures captured from the Infinity Signature Capture app via a PHP cURL request with the supplied reference code “driver-x”.
Request:
$params = array( 'key' => 'aAbBcCdDeE1234567890', 'format' => 'json', 'task' => 'siglist', 'offset' => 0, 'limit' => 20, 'reference' => 'driver-x' ); $settings = array( CURLOPT_URL => 'https://www.infinitysignature.com/api/v1/', CURLOPT_POST => true, CURLOPT_POSTFIELDS => $params, CURLOPT_RETURNTRANSFER => true ); $ch = curl_init(); curl_setopt_array($ch, $settings); $sigs = json_decode(curl_exec($ch), true); curl_close($ch);
Response:
{ "total" : "50", "signature" : [ { "file" : "OjGN4Bhb0uXJFFWbN61F.png", "reference" : "driver-x", "uploaded" : "2015-07-29 18:01:29" }, { "file" : "OjGN4Bhb0uXJ123bN61F.png", "reference" : "driver-x", "uploaded" : "2015-07-30 18:01:29" }, ... ] }
Request:
$params = array( 'key' => 'aAbBcCdDeE1234567890', 'format' => 'xml', 'task' => 'siglist', 'offset' => 0, 'limit' => 20, 'reference' => 'driver-x' ); $settings = array( CURLOPT_URL => 'https://www.infinitysignature.com/api/v1/', CURLOPT_POST => true, CURLOPT_POSTFIELDS => $params, CURLOPT_RETURNTRANSFER => true ); $ch = curl_init(); curl_setopt_array($ch, $settings); $sigs = curl_exec($ch); curl_close($ch);
Response:
<results> <total>50</total> <signature> <file>OjGN4Bhb0uXJFFWbN61F.png</file> <reference>driver-x</reference> <uploaded>2015-07-29 18:01:29</uploaded> </signature> <signature> <file>OjGN4Bhb0u123FWbN61F.png</file> <reference>driver-x</reference> <uploaded>2015-07-30 18:01:29</uploaded> </signature> ... </results>