Liste des Endpoints disponibles

/customers-custom-events/{id} (POST)

Cette méthode permet de créer un nouvel évènement personnalisé dans la timeline d'un profil.

Endpoint : social-sb.com/api/v2/customers-custom-events/{id}

Verb : POST

Paramètres obligatoires

• id : identifiant SPREAD du profil (dans l'URL)
• type : Type d'évènement (comment, message, ...)
• metadata : Liste de méta-données (à définir en fonction du type d'évènement)

Paramètres complémentaires :

• date : Date complète GMT de l'évènement (format: Y-m-d H:i:s)

Exemple d'appel PHP :

$curl_post_data = array(
    "customerCustomEvent" => array (
        "type": "message",
        "date": "2019-05-11 12:00:00",
        "metadata": {
            "subject": "Mon message",
            "text": "Ceci est un message transmis par l'API !"
        }
    )
);
  
$curl_post_data = json_encode($curl_post_data);
  
$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, "<https://social-sb.com/api/v2/customers-custom-events/123456>");
curl_setopt($curl, CURLOPT_POSTREDIR, CURL_REDIR_POST_ALL);
curl_setopt($curl, CURLOPT_FOLLOWLOCATION, true);
curl_setopt($curl, CURLOPT_HTTPAUTH, CURLAUTH_ANY);
// Auth avec la clé publique et la clé privée (voir dans Paramétrage > Tracker)
curl_setopt($curl, CURLOPT_USERPWD, "clef_public:clef_privee");
curl_setopt($curl, CURLOPT_POSTFIELDS, $curl_post_data );
curl_setopt($curl, CURLOPT_POST, true);
curl_setopt($curl, CURLOPT_VERBOSE, 1);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
$curl_return = curl_exec($curl);
var_dump($curl_return);
curl_close($curl);

Réponse :

{
    "customerCustomEvent": {
        "id": 42,
        "type": "message",
        "metadata": {
            "subject": "Mon message",
            "text": "Ceci est un message transmis par l'API !"
        },
        "date": "2019-05-11 12:00:00",
        "createdAt": "2019-05-11 12:00:00",
        "updatedAt": null
    }
}

/customers-custom-events/{id} (GET)

Cette méthode permet de récupérer les évènements personnalisés d'un profil.

Endpoint: social-sb.com/api/v2/customers-custom-events/{id}

Verb: GET

Paramètres obligatoires :

• id : identifiant SPREAD du profil

Paramètres complémentaires :

Aucun