API - CustomEvents

Owned by Julien Cambien (Unlicensed)
Last updated: 28 Jun 2019 by Former user (Deleted)
3 min read

 Pour être informés de toutes les mises à jour concernant l’API v2 de SPREAD, inscrivez-vous ici : https://social-sb.com/z/newsletter-api-v1-v2

Méthodes disponibles


POST Customers Custom Events

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

POST ⇒ social-sb.com/api/v2/customers-custom-events/{id}

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);

Sinon, affichage d'un message d'erreur.


Réponse :

Si POST ok alors :

{
    "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
    }
}

Sinon, affichage d'un message d'erreur.


GET Customers Custom Events

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

GET ⇒ social-sb.com/api/v2/customers-custom-events/{id}

Paramètres obligatoires :

  • "id" : identifiant SPREAD du profil

Paramètres complémentaires :

Aucun

Réponse :

Si GET ok ⇒

{
    "customerCustomEvents": [
        {
            "type": "message",
            "metadata": {
                "subject": "Message subject",
                "text": "This is my message"
            },
            "date": "2019-06-05 11:38:00",
            "createdAt": "2019-06-07 14:23:27",
            "updatedAt": null
        },
        {
            "type": "comment",
            "metadata": {
                "text": "Called us for product informations"
            },
            "date": "2019-06-05 09:42:49",
            "createdAt": "2019-06-05 09:45:08",
            "updatedAt": "2019-06-07 14:16:20"
        }
	],
    "count": 2,
    "nextPageUrl": "https://social-sb.com/api/v2/customers?startAt=2"
}

Sinon, affichage d'un message d'erreur.

Exemple d'appel PHP :

$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, "https://social-sb.com/api/v2/customers-custom-events/123456");
// 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_RETURNTRANSFER, true);
$curl_return = curl_exec($curl);
var_dump($curl_return);
curl_close($curl);