Skip to content
Référence API REST & SDKs

Documentation Développeur Passinstance

Créez des intégrations Apple Wallet (.pkpass) et Google Wallet à grande échelle. Émettez, mettez à jour, validez et diffusez des notifications en direct via des API REST prêtes pour la production.

Obtenir les clés API
Atelier docs en direct — les extraits se mettent à jour en temps réel
Aperçu tableau de bord
Éléments clés de l'interface

Interface Dashboard : Clés d'attributs personnalisés & règles

Les clés définies dans Custom properties (ex. holderName, validUntil) correspondent exactement aux champs JSON de l'API.

Gestion des modèles

7 points de terminaison
GEThttps://api.passinstance.com/api/v1/templatesClé API
Gestion des modèles

Lister tous les modèles

Récupérer une liste paginée des modèles de cartes appartenant à l'espace client authentifié.

En-têtes1 requis
X-API-Keystring
Requis

Clé API secrète de l'espace de travail (pi_live_... ou pi_test_...). Vous pouvez également envoyer Authorization: ApiKey <key>.

Exemple : pi_live_98a7b6c5d4e3f2a1
Paramètres de requête3 optionnel(s)

Codes de statut de réponse

GEThttps://api.passinstance.com/api/v1/templates/{id}Clé API
Gestion des modèles

Obtenir les détails du modèle

Récupérer la configuration complète d'un modèle de carte : couleurs, code-barres, champs de mise en page et règles mécaniques.

En-têtes1 requis
X-API-Keystring
Requis

Clé API secrète de l'espace de travail (pi_live_... ou pi_test_...). Vous pouvez également envoyer Authorization: ApiKey <key>.

Exemple : pi_live_98a7b6c5d4e3f2a1
Paramètres de chemin1 requis
idUUID
Requis

Identifiant unique du modèle.

Exemple : tpl_8f2a1e0b-3c4d-4e5f-9a1b-2c3d4e5f6a7b

Codes de statut de réponse

GEThttps://api.passinstance.com/api/v1/templates/{id}/fieldsClé API
Gestion des modèles

Obtenir les champs du modèle

Récupérez les définitions de champs dynamiques et les clés de propriétés personnalisées pouvant être renseignées par carte pour un modèle donné.

En-têtes1 requis
X-API-Keystring
Requis

Clé API secrète de l'espace de travail (pi_live_... ou pi_test_...). Vous pouvez également envoyer Authorization: ApiKey <key>.

Exemple : pi_live_98a7b6c5d4e3f2a1
Paramètres de chemin1 requis
idstring (UUID)
Requis

UUID unique du modèle.

Exemple : 8f2a1e0b-3c4d-4e5f-9a1b-2c3d4e5f6a7b
Paramètres de requête1 optionnel(s)

Codes de statut de réponse

POSThttps://api.passinstance.com/api/v1/templatesClé API
Gestion des modèles

Créer un modèle de carte

Concevoir et enregistrer un modèle réutilisable avec identité visuelle, type de code-barres, configuration NFC et champs de mise en page.

En-têtes1 requis
X-API-Keystring
Requis

Clé API secrète de l'espace de travail (pi_live_... ou pi_test_...). Vous pouvez également envoyer Authorization: ApiKey <key>.

Exemple : pi_live_98a7b6c5d4e3f2a1

Configuration de création de modèle conforme au schéma JSON OpenAPI.

Corps de la requête6 requis • 4 optionnel(s)
namestring
Requis

Nom d'affichage du modèle.

Exemple : VIP Loyalty Card Template
descriptionstring
Requis

Description détaillée de l'usage de la carte et des avantages.

Exemple : Exclusive loyalty and rewards card for VIP customers
organizationNamestring
Requis

Nom de l'organisation ou marque affiché en haut de la carte.

Exemple : Acme Rewards
kindstring (enum)
Requis

storeCard, coupon, eventTicket, generic, boardingPass ou membership.

Exemple : storeCard
statusstring (enum)
Requis

DRAFT, PUBLISHED, ARCHIVED, DEPRECATED ou UNDER_REVIEW.

Exemple : PUBLISHED
preferredStyleSchemestring (enum)
Requis

DARK, posterGeneric, posterEventTicket, bannerEventTicket ou semanticBoardingPass.

Exemple : DARK

Codes de statut de réponse

POSThttps://api.passinstance.com/api/v1/templates/{id}/publishClé API
Gestion des modèles

Publier un brouillon de modèle

Promouvoir une révision brouillon (rowKind: DRAFT) vers PUBLISHED, marquer changesToPush: true et planifier les mises à jour APNs et Google Wallet pour toutes les cartes actives.

En-têtes1 requis
X-API-Keystring
Requis

Clé API secrète de l'espace de travail (pi_live_... ou pi_test_...). Vous pouvez également envoyer Authorization: ApiKey <key>.

Exemple : pi_live_98a7b6c5d4e3f2a1
Paramètres de chemin1 requis
idstring (UUID)
Requis

UUID du modèle à publier.

Exemple : tpl_8f2a1e0b-3c4d-4e5f-9a1b-2c3d4e5f6a7b

Charge utile de requête contrôlant la publication immédiate ou planifiée et la diffusion des mises à jour wallet.

Corps de la requête4 optionnel(s)

Codes de statut de réponse

POSThttps://api.passinstance.com/api/v1/templates/{id}/copyClé API
Gestion des modèles

Dupliquer le modèle

Dupliquez un modèle de carte existant avec sa mise en page, ses couleurs, ses images et ses mécaniques dans le même espace de travail.

En-têtes1 requis
X-API-Keystring
Requis

Clé API secrète de l'espace de travail (pi_live_... ou pi_test_...). Vous pouvez également envoyer Authorization: ApiKey <key>.

Exemple : pi_live_98a7b6c5d4e3f2a1
Paramètres de chemin1 requis
idstring (UUID)
Requis

UUID du modèle source à dupliquer.

Exemple : 8f2a1e0b-3c4d-4e5f-9a1b-2c3d4e5f6a7b

Optional name, description, and ISO 4217 currency override for the duplicated template.

Corps de la requête3 optionnel(s)

Codes de statut de réponse

DELETEhttps://api.passinstance.com/api/v1/templates/{id}Clé API
Gestion des modèles

Supprimer le modèle

Supprimez un modèle de carte et planifiez une tâche asynchrone pour révoquer et désactiver les cartes associées dans Apple Wallet et Google Wallet.

En-têtes1 requis
X-API-Keystring
Requis

Clé API secrète de l'espace de travail (pi_live_... ou pi_test_...). Vous pouvez également envoyer Authorization: ApiKey <key>.

Exemple : pi_live_98a7b6c5d4e3f2a1
Paramètres de chemin1 requis
idstring (UUID)
Requis

UUID du modèle à supprimer.

Exemple : 8f2a1e0b-3c4d-4e5f-9a1b-2c3d4e5f6a7b

Codes de statut de réponse

Notifications de modèle

3 points de terminaison
POSThttps://api.passinstance.com/api/v1/push-notifications/templates/{id}/sendClé API
Notifications de modèle

Diffuser un push aux cartes d'un modèle

Diffuser une notification push immédiate sur écran verrouillé à toutes les cartes actives Apple Wallet et Google Wallet émises sous un modèle.

En-têtes1 requis
X-API-Keystring
Requis

Clé API secrète de l'espace de travail (pi_live_... ou pi_test_...). Vous pouvez également envoyer Authorization: ApiKey <key>.

Exemple : pi_live_98a7b6c5d4e3f2a1
Paramètres de chemin1 requis
idstring (UUID)
Requis

UUID du modèle dont les appareils enregistrés recevront la diffusion.

Exemple : tpl_8f2a1e0b-3c4d-4e5f-9a1b-2c3d4e5f6a7b

Charge utile Charge utile de requête contenant pushNotificationText (85 car. max) et un texte d'en-tête optionnel.

Corps de la requête1 requis • 1 optionnel(s)
pushNotificationTextstring
Requis

Message sur écran verrouillé diffusé aux cartes actives du modèle (85 car. max ; prend en charge les variables).

Exemple : Flash Sale starts now! Show your VIP pass at checkout for 2x points.

Codes de statut de réponse

GEThttps://api.passinstance.com/api/v1/templates/{id}/notificationClé API
Notifications de modèle

Lister les notifications planifiées

Listez toutes les campagnes de notifications push planifiées et récemment exécutées pour un modèle de carte spécifique.

En-têtes1 requis
X-API-Keystring
Requis

Clé API secrète de l'espace de travail (pi_live_... ou pi_test_...). Vous pouvez également envoyer Authorization: ApiKey <key>.

Exemple : pi_live_98a7b6c5d4e3f2a1
Paramètres de chemin1 requis
idstring (UUID)
Requis

Template UUID.

Exemple : 8f2a1e0b-3c4d-4e5f-9a1b-2c3d4e5f6a7b

Codes de statut de réponse

DELETEhttps://api.passinstance.com/api/v1/templates/notification/{notificationId}Clé API
Notifications de modèle

Annuler une notification planifiée

Annulez une notification push de modèle planifiée en attente avant sa diffusion aux appareils enregistrés.

En-têtes1 requis
X-API-Keystring
Requis

Clé API secrète de l'espace de travail (pi_live_... ou pi_test_...). Vous pouvez également envoyer Authorization: ApiKey <key>.

Exemple : pi_live_98a7b6c5d4e3f2a1
Paramètres de chemin1 requis
notificationIdstring (UUID)
Requis

UUID de la notification planifiée renvoyé lors de la planification ou du listage.

Exemple : f1e2d3c4-b5a6-4987-8765-43210fedcba9

Codes de statut de réponse

Intégrations de modèle

2 points de terminaison
POSThttps://api.passinstance.com/api/v1/integration-connections/embed-widgetsClé API
Intégrations de modèle

Créer une intégration embarquée (iFrame)

Créez une configuration de widget iFrame intégrable pour un modèle publié afin d'embarquer l'inscription de cartes sur votre site web.

En-têtes1 requis
X-API-Keystring
Requis

Clé API secrète de l'espace de travail (pi_live_... ou pi_test_...). Vous pouvez également envoyer Authorization: ApiKey <key>.

Exemple : pi_live_98a7b6c5d4e3f2a1

Configuration for the embedded download widget including templateId and allowed host domains.

Corps de la requête3 requis • 1 optionnel(s)
namestring
Requis

Nom d'affichage pour l'intégration du widget embarqué.

Exemple : Checkout Loyalty Embed Widget
templateIdstring (UUID)
Requis

UUID du modèle de carte cible.

Exemple : 8f2a1e0b-3c4d-4e5f-9a1b-2c3d4e5f6a7b
allowedDomainsstring[]
Requis

Liste des origines (domaines) autorisées à intégrer le widget.

Exemple : ["shop.yourbrand.com", "app.yourbrand.com"]

Codes de statut de réponse