API
RibLink.ru fournit une interface de programmation unifiée pour interagir avec les composants du système.
La requête envoyée à l'API de RibLink.ru s'effectue en transmettant des paramètres POST ou GET, l'ID de l'utilisateur (paramètre user_id) au nom duquel la requête est exécutée, ainsi qu'une clé (paramètre skey) formée par chiffrement des paramètres triés par clé ("assemblés" à l'aide du symbole ":") à l'aide de la méthode sha256 et de la clé secrète de l'utilisateur. La génération de la clé API en PHP se présente comme suit : hash_hmac('sha256', implode(':', $params), {Ваш API ключ из панели управления}, false)
Votre clé API : connectez-vous pour consulter
Selon la langue (en, ru, de, fr, es, zh, hi) et le format dans lesquels vous souhaitez recevoir la réponse (JSON ou XML), le format de l'URL de la requête est défini.
Exemple : https://api.riblink.rufr/request/json/campaigns/create
Afin de ne pas dupliquer les enregistrements pour toutes les variantes de réponse du même type, ce guide se concentrera sur la description du fonctionnement de l'API en utilisant votre langue fr et le format de description des données le plus simple - JSON.
La réponse reçue de l'API peut être de deux types :
1. Succès de l'opération : {result: true, data: ... }
2. Erreur : {result: false, data: "description de l'erreur"}, ou bien {result: false, data: {"param1" => "description de l'erreur", "param2" => "description de l'erreur2", ...}}
Veuillez noter que toutes les dates et heures obtenues via l'API sont indiquées dans le fuseau horaire de l'utilisateur au nom duquel la requête est effectuée. Le fuseau horaire de l'utilisateur peut être modifié dans les Paramètres.
Vous pouvez utiliser une solution prête à l'emploi et télécharger le client d'interaction avec l'API en PHP avec des exemples.
Opérations
Remarque : les champs obligatoires sont marqués en bleu.
Création d’une campagne / Mise à jour des données de la campagne
https://api.riblink.ru/fr/request/json/campaigns/createParamètres:
- title - Nom de la campagne
- campaign_id - ID de la campagne si vous souhaitez mettre à jour les données d’une campagne déjà créée
- links_type - Type de liens : 0 - clé uniquement (par défaut), 1 - clé + partie du lien
- ads_type - Type de publicité : 0 - désactivé, 1 - page intermédiaire (par défaut)
- ads_popunder - Activer le popunder/clickunder (activé par défaut)
- ads_adult - Autoriser la publicité pour adultes (adult) (désactivé par défaut)
- ads_interval - Intervalle d’affichage de la pub pour la même personne (sec.): 0 - sans limite (par défaut), 3600 - une fois par heure, 86400 - une fois par jour
- show_dest_url - Afficher à l’utilisateur le lien de destination final (désactivé par défaut)
- links_title - Titre pour tous les liens
- links_description - Description pour tous les liens
- links_button - Texte du bouton
- public_stat - Statistiques publiques sur les liens
- password - Mot de passe des liens
- password_confirm - Répétez le mot de passe
- domain_id - ID du domaine que vous avez connecté auparavant. Tous les liens de la campagne utiliseront ce domaine
Exemple de réponse:
{
"result": true,
"data": {
"id": 521,
"title": "My new campaign",
"type": "manual",
"status": "active",
"ads_type": 0,
"ads_popunder": 1,
"ads_adult": 0,
"ads_interval": 0,
"links_type": 0,
"show_dest_url": 0,
"links_title": "",
"links_description": "",
"links_button": "",
"has_links_password": true,
"domain": "https://rib1.ru",
"public_stat": 0,
"urls_amount": 0,
"created": "2017-09-15 20:38:54"
}
}
Récupération des données de la campagne
https://api.riblink.ru/fr/request/json/campaigns/getParamètres:
- campaign_id - ID de campagne
Exemple de réponse:
{
"result": true,
"data": {
"id": 521,
"title": "My new campaign",
"type": "manual",
"status": "active",
"ads_type": 0,
"ads_popunder": 1,
"ads_adult": 0,
"ads_interval": 0,
"links_type": 0,
"show_dest_url": 0,
"links_title": "",
"links_description": "",
"links_button": "",
"has_links_password": true,
"domain": "https://rib1.ru",
"public_stat": 0,
"urls_amount": 0,
"created": "2017-09-15 20:38:54"
}
}
Création d’un lien / Mise à jour des données du lien
https://api.riblink.ru/fr/request/json/campaigns/links/createParamètres:
- url - Lien à raccourcir / convertir
- link_id - ID du lien si vous souhaitez mettre à jour les données d’un lien existant
- campaign_id - ID de la campagne à laquelle le lien sera ajouté (uniquement lors de la création). Si rien n’est indiqué, le lien sera ajouté à la campagne par défaut
- url_key - Clé du lien (la fin du lien court). Si elle n’est pas indiquée, une clé aléatoire sera créée
- title - Nom du lien
- description - Description du lien
- button - Texte du bouton
- comment - Commentaire du lien (visible uniquement par vous)
Exemple de réponse:
{
"result": true
}
Récupération des données du lien
https://api.riblink.ru/fr/request/json/campaigns/links/getParamètres:
- link_id - ID du lien
- url_key - Clé du lien (la fin du lien court)
Exemple de réponse:
{
"result": true,
"data": {
"id": 36523,
"campaign_id": 521,
"campaign_title": "My new campaign",
"url_key": "bx5i",
"url": "https://riblink.ru/index/rules",
"title": "",
"description": "",
"button": "",
"comment": "",
"created": "2017-09-16 13:23:24"
}
}