/customfields/{id} (GET)
Cette méthode permet de récupérer les informations d'un champ personnalisé du back office.
Endpoint: social-sb.com/api/v2/customfields/{id}
Verb: GET
Paramètres obligatoires :
id: identifiant SPREAD du champ personnalisé
Paramètres complémentaires :
Aucun
Réponse :
"customfield": {
"id": "1234",
"name": "A un chat",
"type": "radio",
"createdAt": "2019-01-21 09:00:34",
"updatedAt": "2019-01-21 09:01:00",
"status": "1",
"question": "Avez vous un chat ?"
}Exemple d'appel PHP :
$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, "https://social-sb.com/api/v2/customfields/1234");
// Auth avec la clé publique et la clé privée (voir dans Paramétrage > Tracker)
curl_setopt($curl, CURLOPT_USERPWD, "clef_public:clef_prive");
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
$curl_return = curl_exec($curl);
var_dump($curl_return);
curl_close($curl);/customfields (GET)
Cette méthode permet de récupérer tous les champs personnalisés actifs du back office.
Endpoint: social-sb.com/api/v2/customfields
Verb: GET
Paramètres obligatoires :
Aucun
Paramètres complémentaires :
Aucun
Réponse :
"customfields":
[
{
"id": "1234",
"name": "A un chat",
"type": "radio",
"createdAt": "2019-01-08 15:46:39",
"updatedAt": "2019-01-08 15:46:39",
"status": "1",
"question": "Avez vous un chat ?"
},
{
"id": "1235",
"name": "Date de naissance du chat",
"type": "date",
"createdAt": "2019-01-08 15:47:33",
"updatedAt": "2019-01-08 15:47:33",
"status": "1",
"question": null
}
],
"count": 2,
"nextPageUrl": "http://social-sb.com/api/v2/customfields?startAt=2"Exemple d'appel PHP :
$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, "https://social-sb.com/api/v2/customfields");
// 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);Faire une recherche précise :
Il est possible d'affiner la liste retournée en passant des paramètres GET.
Les paramètres d'affinage possibles :
createdAfter⇒ seuls les champs personnalisés créés après la date passée en paramètre seront remontés
createBefore⇒ seuls les champs personnalisés créés avant la date passée en paramètre seront remontés
modifiedAfter⇒ seuls les champs personnalisés modifies après la date passée en paramètre seront remontés
modifiedBefore⇒ seuls les champs personnalisés modifiés avant la date passée en paramètre seront retournés
type⇒ seuls les champs personnalisés du même type que celui passé en paramètres seront retournés. Les valeurs possibles :textnumericradiodateuniquemultiple
Les paramètres sur la pagination :
startAt⇒ permet de commencer la liste des commandes à partir de l'occurence passée en paramètre
maxResult⇒ permet de limiter le nombre de commandes remontées par pages (max 5000)
Si vous avez d’autres questions sur ce sujet, vous pouvez contacter le support. 💬