Documentation

Introduction

Bienvenue dans la documentation développeur et la référence API de Rulrr.

Avant de commencer

Si ce n'est pas déjà fait, soumettez votre formulaire de candidature pour devenir un Partenaire Intégré officiel de Rulrr et commencez à offrir à vos clients les avantages de la publicité numérique automatisée. Les candidatures sont examinées sous un délai maximum de 7 jours ouvrables ; en cas d'approbation, vous recevrez un identifiant client (client ID) et une clé secrète (client secret) uniques, nécessaires pour créer avec succès tout type de requête.

L'API Rulrr permet d'intégrer différents systèmes de point de vente (POS) au moteur marketing automatisé de Rulrr. En connectant leur POS à Rulrr, les propriétaires de magasins peuvent créer des campagnes publicitaires ciblées pour leur clientèle spécifique et mesurer l'efficacité de ces campagnes.

L'expérience utilisateur

Le parcours utilisateur comprend les étapes suivantes :

• L'utilisateur lance le processus d'intégration dans l'application Rulrr en sélectionnant une application client qui s'intègre au flux oAuth de Rulrr. (Créer une campagne > Intégration POS)
• L'application présentera les instructions à effectuer du côté de l'application client.
• L'utilisateur suit les instructions et active la fonctionnalité Rulrr-Connect sur son application client.

Le flux OAuth

Le processus d'intégration comprend les étapes suivantes :

• Le POS demande le jeton d'intégration en transmettant l'identifiant client (client ID) et la clé secrète (client secret) (fournis par Rulrr) dans les paramètres. Rulrr crée une entité d'intégration dans la base de données avec ce jeton et le statut « pending », puis renvoie un jeton d'accès au POS.
• Le POS envoie une requête périodique vérifiant le statut de l'intégration, en transmettant l'identifiant client (client ID), la clé secrète (client Secret) et le jeton d'intégration dans les paramètres. Il attend le statut finished afin de récupérer le jeton d'accès.
• Le POS affiche un IFrame avec le site connect.rulrr.com. Il doit contenir :

• integration_token transmis en tant que paramètre
• client_id transmis en tant que paramètre

• L'utilisateur complète le formulaire de vérification du compte et de préférences d'intégration dans l'IFrame ; une fois terminé, le statut d'intégration doit passer à « finished ».
• Le POS détecte un changement de statut (via une requête périodique) et envoie une requête pour récupérer les jetons d'accès et de rafraîchissement créés. Ce point de terminaison ne renvoie les jetons qu'une seule fois !
• L'application client a alors accès aux points de terminaison suivants : Mettre à jour le profil du magasin, Envoyer la liste des clients et Envoyer une commande unique.

Exigences et limitations

• Les codes d'autorisation renvoyés par la page web de l'URL d'autorisation expirent après 15 minutes. Un code d'autorisation ne peut être utilisé qu'une seule fois.
• Les jetons d'accès expirent après 365 jours. Pour conserver l'accès, vous devez générer un nouveau jeton d'accès à l'aide du jeton de rafraîchissement reçu avec l'autorisation initiale.
• Les jetons de rafraîchissement obtenus via le flux de code n'expirent pas. Si vous perdez un jeton de rafraîchissement, vous devez répéter l'intégralité du flux d'autorisation pour obtenir un nouveau jeton d'accès et un nouveau jeton de rafraîchissement. Un jeton de rafraîchissement ne devient invalide que lorsque l'accès de l'application client a été entièrement révoqué.