REST API Reference

We provide complete, secure and thorough access to all the data stored within your Synchroteam.com account. Use the menu on the right to consult the specifications for the REST operations that are available.

Connecting to access the Web Services

The Synchroteam API is implemented over authenticated HTTP and returns data in JSON or XML format. Four HTTP methods are used: GET, POST, PUT and DELETE.

Authentication

All API requests are made via HTTPS using the secure domain apis.synchroteam.com, and take the following form:

https://apis.synchroteam.com/Api/v1/{method}/{action}/{id}

To connect using basic HTTP authentication, you will need both your personnalized domain identifier and your 40-digit API key. For example:

Domain identifier
mydomain.synchroteam.com
Api Key
ff8e5b63-0e74-4102-ba93-c829acfb58f3

In your HTTP basic authentication code, the domain identifier is the user id, and the API key is the password.

Here's an example using curl:

curl -u mydomain:ff8e5b63-0e74-4102-ba93-c829acfb58f3 -H "Accept: application/json" -H "Content-Type: application/json" https://apis.synchroteam.com/Api/v1/user/List

Sample Connection Code (PHP)

<?php

$xmlPostData = "<?xml version=\"1.0\" encoding =\"utf-8\">
<user>
	<profile>oper</profile>
	<login>login_user</login>
	<password>H@rdpa$$w0rD</password>
	<lastname>Doe</lastname >
	<firstname>John</firstname >
	<language>en</language >
	<phone>333 444-5555</phone>
	<email>johndoe@mydomain.com</email>
</user>
"

// Initialise and return the cURL handle
$ch = curl_init('https://apis.synchroteam.com/Api/v1/user/Update/login_user');

// set appropriate options:
// CURLOPT_USERPWD is where you authenticate the connection
$options = array(CURLOPT_USERPWD => 'mydomain:ff8e5b63-0e74-4102-ba93-c829acfb58f3',
            CURLOPT_HTTPHEADER => array('Content-Type: text/xml','Accept: text/xml'),
            CURLOPT_HEADER => true,
            CURLOPT_RETURNTRANSFER => true,
            CURLOPT_POST => true,
            CURLOPT_POSTFIELDS => $xmlPostData
                );
curl_setopt_array($ch, $options); 

// Execute. Save the response for further processing if needed
$response = curl_exec($ch);
$responseInfo = curl_getinfo($ch);
curl_close($ch);
?>