Intégration des développeurs

7stamp REST API

Disponible

Le 7stamp Integration API permet à un CRM, une plateforme de commerce électronique, un POS, un backend personnalisé ou un outil d'automatisation de gérer cartes de fidélité portefeuille avec l'identifiant de contact que votre propre système utilise déjà. C'est l'option universelle lorsqu'une intégration spécialisée n'existe pas.

La base API URL est https://api.7loc.com/cards-api. Authentifiez chaque demande avec une clé API en tant que jeton Bearer. Utilisez la référence liée OpenAPI pour les schémas de demande et de réponse en direct avant de créer une logique de production.

Ce que vous pouvez faire avec le API

Le API est le côté écriture de la pile d'intégration. Utilisez-le chaque fois que votre propre logiciel doit rester la source opérationnelle de vérité pendant que 7stamp gère la couche de fidélité du portefeuille.

Émettez des cartes à partir de votre propre logiciel

Générez un lien de carte de portefeuille personnel pour n'importe quel client de votre système. Distribuez-le via votre propre e-mail, SMS, push ou via un flux intégré à l'application. Le client ouvre le lien et enregistre la carte au Apple Wallet ou au Google Wallet.

Tampons de crédit de n'importe quelle source

Lorsqu'un achat est conclu dans votre POS personnalisé, lorsqu'une commande en ligne est payée sur votre site Web ou lorsqu'un service est effectué dans votre système de réservation, appelez le API pour créditer les tampons. La carte se met à jour en quelques secondes.

Gérer les bons et les campagnes

Émettez un bon unique à un client spécifique, créez des flux de récompenses prêts pour la campagne et récupérez le statut du bon dans les systèmes qui gèrent les finances et la qualité du service.

Intégration documentée API opérations

Ce sont les routes publiques API derrière le Actions Make et Zapier. Lisez le schéma exact dans la référence API; ne déduisez pas les noms de champs d’un point de terminaison différent.

Cartes POST /cards/invite

Créer une carte d'invitation

Crée une nouvelle installation personnelle URL pour un contact externe.

Cartes POST /cards/invite/bulk

Créer des invitations de cartes en masse

Crée jusqu'à 100 liens d'invitation dans un lot contrôlé.

Cartes GET /cards

Rechercher des cartes

Recherche les enregistrements de cartes par identifiant de contact externe.

Cartes GET /cards/{user_card_id}

Obtenir les détails de la carte

Renvoie l'état complet d'une carte par son interne 7stamp ID.

Cartes POST /cards/scan

Scanne une carte

Ajoute des tampons par carte ID ou External ID et enregistre la commande source une fois fournie.

Modèles GET /templates

Liste des modèles

Répertorie les modèles de cartes disponibles sur le lieu de travail de la clé/profile.

Modèles GET /templates/{template_id}/design

Obtenir la conception du modèle

Lit les paramètres visuels d'un modèle de carte connu.

Bons POST /vouchers/issue

Émettre un bon

Émet un bon à un propriétaire de carte.

Messages POST /messages/send

Envoyer un message

Envoie un message push de carte de portefeuille et/or un contenu par courrier électronique à un propriétaire de carte.

Où créer et copier la touche API

Ce sont de vrais écrans 7stamp Admin. Ouvrez API & Intégrations, ajoutez une clé, puis copiez-la dans une connexion secrète sécurisée côté serveur ou une connexion d'automatisation.

7stamp Admin API Écran & Intégrations affichant le bouton Add API Key et la boîte de dialogue Générer API Key
Étape 1 — Sélectionnez API & Intégrations dans le volet de navigation de gauche, ouvrez API Keys, choisissez Add API Key, sélectionnez la connexion du personnel appropriée et générez la clé. Boîte de dialogue
7stamp Admin affichant une clé API nouvellement générée et son contrôle de copie
Étape 2 — Copiez la nouvelle clé dans un gestionnaire de mots de passe, un secret côté serveur ou une connexion sécurisée Make/Zapier. Ne le collez pas dans le code source, une application de navigateur ou un ticket d'assistance.

Trois décisions à prendre avant de coder

API portée de la clé

Créez la clé dans 7stamp Admin sous API Integrations → API KeysAdd API Key. Une clé appartient à un seul lieu de travail/profile, créez donc des clés distinctes pour le développement et la production lorsque la configuration de votre compte le permet. Faites pivoter ou révoquez l'accès depuis le tableau de bord si un secret est exposé.

Identité du client

External ID est l'identifiant de contact stable de votre système: un CRM ID, un client UUID, un numéro de téléphone ou un e-mail. Préférez un système immuable ID. Ajoutez éventuellement External Source pour éviter les collisions entre les systèmes et rendre explicite la corrélation des webhooks.

Sélection du modèle

Lorsque le profil a un modèle actif, template_id peut être omis et 7stamp le sélectionne automatiquement. Lorsqu'il dispose de plusieurs modèles actifs, transmettez le template_id prévu. Lisez d'abord GET /templates plutôt que de coder en dur un ID deviné.

Demande authentifiée minimale: créer une invitation

Copiez ceci dans votre étape d'automatisation bash
curl -X POST "https://api.7loc.com/cards-api/cards/invite" \
  -H "Authorization: Bearer YOUR_7STAMP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "external_id": "crm_contact_8821",
    "external_source": "hubspot",
    "template_id": 42
  }'

De la clé API à une première demande réussie

01

Connectez-vous à 7stamp Admin et créez une clé: API Integrations → API KeysAdd API Key. Stockez-le dans votre gestionnaire de secrets, pas dans le code source ou dans une application côté client.

02

Définissez la base URL sur https://api.7loc.com/cards-api et ajoutez Authorization: Bearer suivi de la clé à chaque requête côté serveur.

03

Appelez d'abord le GET /templates. Une réponse réussie confirme le jeton et affiche les modèles disponibles pour ce lieu de travail/profile.

04

Choisissez le stable External ID et facultatif External Source depuis votre propre système. Utilisez exactement la même paire d’identités dans la logique de création, d’analyse, de recherche et de webhook.

05

Appelez le POST /cards/invite avec un contact test jetable. Vérifiez l'installation renvoyée URL avant d'automatiser la livraison aux vrais clients.

06

Ajoutez POST /cards/scan, un bon ou des actions de message uniquement après avoir effectué la journalisation, la gestion des erreurs et une stratégie de nouvelle tentative/idempotency sécurisée dans votre propre backend.

Utiliser la référence API comme contrat

La référence publique Swagger/OpenAPI contient les schémas actuels de point de terminaison, de paramètre, de corps de requête, de réponse et de webhook. Le URL interactif est https://api.7loc.com/cards-api/docs et le contrat lisible par machine est https://api.7loc.com/cards-api/openapi.json. Lisez-le avant d'implémenter la gestion des erreurs ou d'ajouter des champs facultatifs.

Authentification et sécurité des clés

La clé est un secret côté serveur. Ne l'exposez pas dans le JavaScript du navigateur, dans un ensemble d'applications mobiles, dans un formulaire public, dans des captures d'écran, dans des champs de texte Make/Zapier ou dans des tickets d'assistance. Utilisez un serveur, une connexion d'automatisation sécurisée ou un gestionnaire de secrets. Si la clé est partagée accidentellement, révoquez-la ou faites-la pivoter dans 7stamp Admin et mettez à jour la connexion concernée.

Questions fréquemment posées

Où puis-je obtenir un jeton 7stamp API?

Dans 7stamp Admin, rendez-vous sur API Integrations → API Keys → Add API Key. Le jeton est ensuite envoyé dans l'en-tête Authorization sous la forme Bearer suivi de la clé.

Quelle est la base URL et la méthode d'authentification?

Utilisez https://api.7loc.com/cards-api et envoyez Authorization: Bearer YOUR_7STAMP_API_KEY à chaque demande autorisée.

Quand puis-je omettre template_id?

Uniquement lorsque le profil connecté possède exactement un modèle de carte actif. Si plusieurs modèles sont actifs, sélectionnez le bon template_id parmi GET /templates.

Dois-je utiliser le API, Make ou Zapier?

Utilisez le API pour un POS personnalisé, un backend, un site ou un contrôle total. Utilisez Make pour les scénarios de branchement visuel. Utilisez Zapier pour un flux de travail d'action de déclenchement principalement linéaire. Tous les trois s'appuient sur la même clé API et le même contrat API.

Étape suivante

Testez d'abord le plus petit coffre-fort API flux

Créez la clé, appelez le GET /templates, créez une invitation pour un contact jetable, puis ajoutez les secrets de production, la journalisation, les tentatives et la gestion des webhooks autour de la demande prouvée.