Démarrage rapide
Ce guide donne un aperçu de haut niveau du parcours d'intégration Otonum de votre première clé API à la première récompense attribuée à un client.
Pour le format exact des requêtes et réponses de chaque point de terminaison, consultez la Référence API.
Avant de commencer
Assurez-vous d'avoir :
- Un compte Otonum actif (inscription sur otonum.io)
- L'accès à votre application Otonum Recompenses
-
Créer votre clé API
Toutes les requêtes vers l'API Otonum s'authentifient avec une clé API secrète qui identifie votre compte. Depuis votre application Otonum Recompenses, accédez à Applications → Accès API → Nouveau secret client.
Stockez-la dans une variable d'environnement. Elle ne peut être vue qu'une seule fois et donne accès complet à vos données de fidélisation.
Consultez Authentification pour les bonnes pratiques de gestion des clés.
-
Comprendre les paramètres de votre programme
Avant de construire votre intégration, lisez les paramètres de votre application pour connaître les règles qui régissent votre programme. taux de gains, seuils de remboursement et politiques d'expiration.
- Programme cashback : quel pourcentage est retourné par transaction, et quel est le solde minimum avant que l'échange soit disponible.
- Programme de points : combien de points valent combien en valeur monétaire, et le minimum de points requis pour créer un bon d'échange.
Consultez Paramètres de l'application pour tous les détails.
-
Inscrire vos clients
Un client doit être inscrit avant de pouvoir gagner ou échanger des récompenses. Vous pouvez inscrire les clients individuellement (lors d'une inscription ou d'un opt-in) ou en lot (lors de la migration d'une base de données existante).
Chaque client inscrit reçoit un code personnel. un identifiant court qu'il présente à la caisse pour relier les transactions à son compte.
-
Enregistrer les achats
Chaque fois qu'un client complète une transaction dans votre système, soumettez-la à Otonum. La plateforme évalue l'achat par rapport à vos campagnes actives et calcule la récompense applicable de façon asynchrone.
Utilisez toujours l'identifiant interne de votre commande comme
referencepour éviter le double traitement lors de nouvelles tentatives. -
Afficher le retour au client
Après la soumission d'un achat, Otonum notifie le client automatiquement (courriel ou push, selon vos paramètres). Optionnellement, vous pouvez interroger le point de terminaison Statut des tâches pour confirmer l'achèvement et afficher la récompense gagnante dans votre propre interface.
Étapes suivantes
- Authentification. Gestion des clés et sécurité
- Identité client. Codes personnels et soldes Membre
- Campagnes. Comment fonctionnent les règles de récompense
- Guide d'intégration. Flux de caisse complet de bout en bout
- Bonnes pratiques. Gestion des erreurs, limites de débit et résilience
