/sponsorships (GET)

Récupère les informations de tous les parrainages.

Endpoint: social-sb.com/api/v2/sponsorships

Verb: GET

Paramètres obligatoires :

Aucun

Paramètres complémentaires :

Aucun

Réponse :

{
  "sponsorships": [
    {
      "id": "671487",
      "campaignId": "32951",
      "godfatherId": "14703899",
      "godsonId": "14703899",
      "sponsorshipValidated": "0",
      "createdAt": "2016-11-04 08:54:47",
      "updatedAt": "2016-11-04 08:57:27",
      "validatedAt": null
    },
    {
      "id": "671488",
      "campaignId": "32951",
      "godfatherId": "14703899",
      "godsonId": "14703901",
      "sponsorshipValidated": "0",
      "createdAt": "2016-11-04 08:54:47",
      "updatedAt": "2016-11-04 08:56:14",
      "validatedAt": null
    },
    // [...]
  ],
  "count": 10,
  "nextPageUrl": "http://social-sb.com/api/v2/sponsorships/?maxResults=10&startAt=10"
}

Exemple d'appel PHP :

$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, "https://social-sb.com/api/v2/sponsorships/");
// Auth avec la clé publique et la clé privée (voir dans Paramétrage > Tracker)
curl_setopt($curl, CURLOPT_USERPWD, "clef_public:cle_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 parrainages créés après la date passée en paramètre seront remontés

createBefore ⇒ seuls les parrainages créés avant la date passée en paramètre seront remontés

modifiedAfter ⇒ seuls les parrainages modifiés après la date passée en paramètre seront remontés

modifiedBefore ⇒ seuls les parrainages modifiés avant la date passée en paramètre seront retournés

operartionId ⇒ seuls les parrainages appartenant à l'opération passée en paramètres seront retournés

url ⇒ seule la campagne dont l'url est égale à celle passée en paramètre sera retourné

Les paramètres sur la pagination :

startAt ⇒ permet de commencer la liste des parrainages à partir de l'occurence passée en paramètre

maxResult ⇒ permet de limiter le nombre de parrainages remontés par pages (max 5000)

/sponsorships/{id} (GET)

Récupère les informations d'un parrainage.

Endpoint: social-sb.com/api/v2/sponsorships/{id}

Verb: GET

Paramètres obligatoires :

id : l'identifiant SPREAD du parrainage

Paramètres complémentaires :

Aucun

Réponse :

// Pour un parrainage validé
{
  "sponsorship": {
    "id": "671930",
    "campaignId": "32951",
    "godfatherId": "15014311",
    "godsonId": "15014312",
    "sponsorshipValidated": "1",
    "createdAt": "2019-01-25 10:00:03",
    "updatedAt": "2019-01-25 10:16:23",
    "validatedAt": "2019-01-25 10:16:23"
  }
}

// Pour un parrainage non validé
{
  "sponsorship": {
    "id": "671931",
    "campaignId": "32951",
    "godfatherId": "15014313",
    "godsonId": "15014314",
    "sponsorshipValidated": "0",
    "createdAt": "2019-01-25 10:18:31",
    "updatedAt": "2019-01-25 10:18:31",
    "validatedAt": null
  }
}

Exemple d'appel PHP :

$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, "https://social-sb.com/api/v2/sponsorships/123456");
// Auth avec la clé publique et la clé privée (voir dans Paramétrage > Tracker)
curl_setopt($curl, CURLOPT_USERPWD, "clef_public:cle_privee");
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
$curl_return = curl_exec($curl);
var_dump($curl_return);
curl_close($curl);

/sponsorships/create (POST)

Permet de créer un lien de parrainage entre 2 profils SPREAD.

Endpoint: social-sb.com/api/v2/sponsorships/create

Verb: GET

Paramètres obligatoires :

godfatherId : identifiant numérique SPREAD du parrain

godsonId : identifiant numérique SPREAD du filleul

campaignId : identifiant numérique SPREAD du module de parrainage

Paramètres complémentaires :

Aucun

Réponse :

{
  "sponsorship": {
    "id": "672078",
    "campaignId": "32951",
    "godfatherId": "15125705",
    "godsonId": "15125687",
    "sponsorshipValidated": "0",
    "createdAt": "2020-08-06 14:00:49",
    "updatedAt": "2020-08-06 14:00:49",
    "validatedAt": null
  }
}

Exemple d'appel PHP :

$curl_post_data = [
    'sponsorship' => [
				'godfatherId' => 15125705,
        'godsonId' => 15125687,
        'campaignId' => 32951
    ]
];
 
$curl_post_data = json_encode($curl_post_data);
 
$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, "https://social-sb.com/api/v2/sponsorships/create");
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);

/sponsorships/activate (POST)

Permet d'activer un lien de parrainage entre 2 profils SPREAD.

Endpoint: social-sb.com/api/v2/sponsorships/activate

Verb: GET

Paramètres obligatoires :

godFatherId : identifiant numérique SPREAD du parrain

godsonId : identifiant numérique SPREAD du filleul

campaignId : identifiant numérique SPREAD du module de parrainage

Paramètres complémentaires :

Aucun

Réponse :

{
  "sponsorship": {
    "id": "672078",
    "campaignId": "32951",
    "godfatherId": "15125705",
    "godsonId": "15125687",
    "sponsorshipValidated": "0",
    "createdAt": "2020-08-06 14:00:49",
    "updatedAt": "2020-08-06 14:03:50",
    "validatedAt": null
  }
}

Exemple d'appel PHP :

$curl_post_data = [
    'sponsorship' => [
				'godfatherId' => 15125705,
        'godsonId' => 15125687,
        'campaignId' => 32951
    ]
];
 
$curl_post_data = json_encode($curl_post_data);
 
$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, "https://social-sb.com/api/v2/sponsorships/activate");
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);

/sponsorships/validate (POST)

Permet de valider l'objectif "API" d'un module de parrainage pour le parrainage entre 2 profils SPREAD.

⚠️

Il faut que le module de parrainage lié ait bien l'objectif API activé.

Endpoint: social-sb.com/api/v2/sponsorships/validate

Verb: GET

Paramètres obligatoires :

godfatherId : identifiant numérique SPREAD du parrain

godsonId : identifiant numérique SPREAD du filleul

campaignId : identifiant numérique SPREAD du module de parrainage

Paramètres complémentaires :

Aucun

Réponse :

{
  "sponsorship": {
    "id": "672078",
    "campaignId": "32951",
    "godfatherId": "15125705",
    "godsonId": "15125687",
    "sponsorshipValidated": "0",
    "createdAt": "2020-08-06 14:00:49",
    "updatedAt": "2020-08-06 14:03:50",
    "validatedAt": null
  }
}

Exemple d'appel PHP :

$curl_post_data = [
    'sponsorship' => [
				'godfatherId' => 15125705,
        'godsonId' => 15125687,
        'campaignId' => 32951
    ]
];
 
$curl_post_data = json_encode($curl_post_data);
 
$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, "https://social-sb.com/api/v2/sponsorships/validate");
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);

/sponsorships/godfather/{id} (GET)

Récupère les informations d'un parrainage depuis l'id Filleuil.

Endpoint: social-sb.com/api/v2/sponsorships/godfather/{id}

Verb: GET

Paramètres obligatoires :

id : l'identifiant SPREAD du Filleuil

Paramètres complémentaires :

Aucun

Réponse :

// Pour un parrainage validé
{
  "sponsorship": {
    "id": "671930",
    "campaignId": "32951",
    "godfatherId": "15014311",
    "godsonId": "15014312",
    "sponsorshipValidated": "1",
    "createdAt": "2019-01-25 10:00:03",
    "updatedAt": "2019-01-25 10:16:23",
    "validatedAt": "2019-01-25 10:16:23"
  }
}

// Pour un parrainage non validé
{
  "sponsorship": {
    "id": "671931",
    "campaignId": "32951",
    "godfatherId": "15014313",
    "godsonId": "15014314",
    "sponsorshipValidated": "0",
    "createdAt": "2019-01-25 10:18:31",
    "updatedAt": "2019-01-25 10:18:31",
    "validatedAt": null
  }
}

Exemple d'appel PHP :

$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, "https://social-sb.com/api/v2/sponsorships/godfather/123456");
// Auth avec la clé publique et la clé privée (voir dans Paramétrage > Tracker)
curl_setopt($curl, CURLOPT_USERPWD, "clef_public:cle_privee");
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
$curl_return = curl_exec($curl);
var_dump($curl_return);
curl_close($curl);

🆘

Si vous avez d’autres questions sur ce sujet, vous pouvez contacter le support. 💬

Sponsorships

/sponsorships (GET)

/sponsorships/{id} (GET)

/sponsorships/create (POST)

/sponsorships/activate (POST)

/sponsorships/validate (POST)

/sponsorships/godfather/{id} (GET)