Skip to content
Guide du centre d'aide · Outils développeur
2 min de lectureVérifié 2026-11-16

Utilitaires d'intégration

Exploitez les jetons SDK, URLs Wallet dynamiques paramétrées, workflows IA .pkpass et schémas OpenAPI.

Dans ce guide

Aperçu

Pour accélérer l'intégration backend sur Node.js/TypeScript, Python, PHP et en ligne de commande — en complément des utilitaires développeur du tableau de bord disponibles sous /settings/workspace/integrations/link-generator, /settings/workspace/developer/embed-sdk, /settings/workspace/developer/sdks, /settings/workspace/developer/query-helper et /settings/workspace/developer/qr-generator — ce guide fournit des modèles prêts pour la production : upsert idempotent de passes (POST /api/v1/passes/upsert-by-external-id), liens de téléchargement paramétrés (PARAMETERIZED_PASS_LINK / CREATE_PASS_URL), pagination par curseur et vérification HMAC-SHA256 en temps constant.

Important : Synchronisez un enregistrement métier par upsert avec (templateId, externalId). Le passe renvoyé se trouve dans data.pass et le résultat dans data.action (CREATED ou UPDATED). Pour POST /api/v1/passes, envoyez un en-tête Idempotency-Key afin que les nouvelles tentatives réutilisent la même demande de création. L’endpoint d’upsert ne traite pas cet en-tête.

Flux d'upsert idempotent et de pagination par curseur

FLUX ARCHITECTURE SYSTÈME
ARCHITECTURE INTERACTIVE
MODÈLE D'UPSERT IDEMPOTENT & PAGINATION PAR CURSEUR
ACTEURS SYSTÈME PARTICIPANTS
P1 Votre application backend
P2 API REST Passinstance (/api/v1)
ÉTAPE 1 REQUÊTE / ACTION POST/passes/upsert-by-external-id
›
{ templateId, externalId, attributes }
›
Correspondance (templateId + externalId)
›
Crée si nouveau OU met à jour & pousse si existant
ÉTAPE 2 RÉPONSE 200 OK data: { pass, action }
ÉTAPE 3 REQUÊTE / ACTION GET/scans/offline-dataset
›
?limit=250
ÉTAPE 4 RÉPONSE 200 OK { data: { passes, nextCursor: "c_1" } }
ÉTAPE 5 REQUÊTE / ACTION GET/scans/offline-dataset
›
?limit=250&cursor=c_1&snapshotAt=...
ÉTAPE 6 RÉPONSE 200 OK { data: { passes, hasMore: false } }

Exemples de code multi-langages pour la production

1. Node.js / TypeScript : assistant d'upsert idempotent de passe

TYPESCRIPT
interface IUpsertPassPayload {
  templateId: string;
  externalId: string;
  attributes: Record<string, string | number | boolean>;
  expirationDate?: string;
}

export async function upsertWalletPass(payload: IUpsertPassPayload) {
  const response = await fetch('https://api.passinstance.com/api/v1/passes/upsert-by-external-id', {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
      'x-api-key': process.env.PASSINSTANCE_API_KEY ?? '',
    },
    body: JSON.stringify(payload),
  });

  const body = await response.json();
  if (!response.ok || !body.success) {
    throw new Error(`Passinstance API error [${body.errorCode ?? response.status}]: ${body.message}`);
  }
  return body.data.pass as { id: string; serialNumber: string; externalId?: string; passAccessUrl: string };
}

2. Python : upsert idempotent et vérificateur HMAC de webhook

PYTHON
import hmac
import hashlib
import os
import requests

API_BASE_URL = "https://api.passinstance.com/api/v1"
API_KEY = os.environ["PASSINSTANCE_API_KEY"]

def upsert_pass_by_external_id(template_id: str, external_id: str, attributes: dict) -> dict:
    response = requests.post(
        f"{API_BASE_URL}/passes/upsert-by-external-id",
        headers={
            "x-api-key": API_KEY,
            "Content-Type": "application/json",
        },
        json={
            "templateId": template_id,
            "externalId": external_id,
            "attributes": attributes,
        },
        timeout=10,
    )
    response.raise_for_status()
    return response.json()["data"]["pass"]

def verify_webhook_signature(raw_body: bytes, signature_header: str, secret: str) -> bool:
    if not signature_header or not signature_header.startswith("sha256="):
        return False
    digest = hmac.new(secret.encode("utf-8"), raw_body, hashlib.sha256).hexdigest()
    expected = f"sha256={digest}"
    return hmac.compare_digest(signature_header, expected)

3. PHP : émission/mise à jour d'un passe et vérification de webhook

PHP
<?php
function upsertPassinstancePass(string $templateId, string $externalId, array $attributes): array {
    $payload = json_encode([
        'templateId' => $templateId,
        'externalId' => $externalId,
        'attributes' => $attributes,
    ], JSON_THROW_ON_ERROR);

    $ch = curl_init('https://api.passinstance.com/api/v1/passes/upsert-by-external-id');
    curl_setopt_array($ch, [
        CURLOPT_RETURNTRANSFER => true,
        CURLOPT_POST           => true,
        CURLOPT_POSTFIELDS     => $payload,
        CURLOPT_HTTPHEADER     => [
            'Content-Type: application/json',
            'x-api-key: ' . getenv('PASSINSTANCE_API_KEY'),
        ],
    ]);
    $raw = curl_exec($ch);
    curl_close($ch);
    return json_decode($raw, true, 512, JSON_THROW_ON_ERROR)['data']['pass'];
}

function verifyPassinstanceWebhook(string $rawBody, string $signatureHeader, string $secret): bool {
    $expected = 'sha256=' . hash_hmac('sha256', $rawBody, $secret);
    return hash_equals($expected, $signatureHeader);
}

4. cURL : référence rapide en ligne de commande

BASH
curl -X POST "https://api.passinstance.com/api/v1/passes/upsert-by-external-id" \
  -H "Content-Type: application/json" \
  -H "x-api-key: pi_live_89a1f4c2e90b41d7a6c3e2f10984b2c1" \
  -d '{
    "templateId": "6f2c5130-2f2a-4f40-8c68-f7192c5b4f43",
    "externalId": "cust_9012",
    "attributes": {
      "memberName": "Clara Oswald",
      "points": 1250,
      "tier": "GOLD"
    }
  }'

Pagination des instantanés du scanner hors ligne

GET /api/v1/scans/offline-dataset nécessite x-scanner-key et renvoie l’instantané dans une réponse contenant success, data et metadata. Conservez le même snapshotAt sur toutes les pages.

Paramètre / Champ de réponseTypeDescription
limitnumberPasses par page (valeur par défaut 500, maximum 1000).
cursorstringUtilisez data.nextCursor de la réponse précédente ; omettez-le dans la première requête.
snapshotAtstring (ISO 8601)Réutilisez data.snapshotAt de la première réponse comme borne supérieure de l’instantané pour les pages suivantes.
data.passesArrayInstantanés de passes limités à la configuration du scanner.
data.hasMorebooleanContinuez à charger les pages tant que cette valeur est true.
data.nextCursorstringÀ utiliser comme cursor lorsque data.hasMore vaut true ; ce champ est omis sur la dernière page.

Explorez les schémas OpenAPI en direct sur /docs, effectuez vos tests avec notre collection Bruno dans Tests & débogage, ou concevez des modèles de passes avec l'IA dans Créer votre premier passe Wallet.

Documentation produit et développeur associée

Prêt à lancer votre premier programme de cartes Wallet ?

Créez votre espace de travail, configurez votre modèle et testez une vraie carte dans Apple Wallet et Google Wallet avant de déployer à grande échelle.