Skip to content
Guia da Central de Ajuda · Ferramentas de desenvolvimento
2 min de leituraVerificado 2026-11-16

Utilitários de integração

Utilize tokens SDK, URLs Wallet dinâmicos parametrizados, fluxos IA .pkpass e esquemas OpenAPI.

Neste guia

Visão geral

Para acelerar a integração backend em ambientes Node.js/TypeScript, Python, PHP e shell — a par das ferramentas para programadores no Painel em /settings/workspace/integrations/link-generator, /settings/workspace/developer/embed-sdk, /settings/workspace/developer/sdks, /settings/workspace/developer/query-helper e /settings/workspace/developer/qr-generator — este guia apresenta padrões produtivos de upsert idempotente (POST /api/v1/passes/upsert-by-external-id), ligações parametrizadas (PARAMETERIZED_PASS_LINK / CREATE_PASS_URL), paginação por cursor e verificação HMAC-SHA256 de webhooks em tempo constante.

Importante: Sincronize um registo de negócio por upsert com (templateId, externalId). O passe devolvido está em data.pass e o resultado em data.action (CREATED ou UPDATED). Para POST /api/v1/passes, envie um cabeçalho Idempotency-Key para que as repetições reutilizem o mesmo pedido de criação. O endpoint de upsert não processa esse cabeçalho.

Fluxo de Upsert Idempotente e Paginação por Cursor

FLUXO DE ARQUITETURA
ARQUITETURA INTERATIVA
PADRÃO DE UPSERT IDEMPOTENTE E PAGINAÇÃO POR CURSOR
ATORES DE SISTEMA PARTICIPANTES
P1 A Sua Aplicação Backend
P2 API REST Passinstance (/api/v1)
ETAPA 1 PEDIDO / AÇÃO POST/passes/upsert-by-external-id
›
{ templateId, externalId, attributes }
›
Correspondência (templateId + externalId)
›
Cria se novo OU Atualiza & Push se existir
ETAPA 2 RESPOSTA 200 OK data: { pass, action }
ETAPA 3 PEDIDO / AÇÃO GET/scans/offline-dataset
›
?limit=250
ETAPA 4 RESPOSTA 200 OK { data: { passes, nextCursor: "c_1" } }
ETAPA 5 PEDIDO / AÇÃO GET/scans/offline-dataset
›
?limit=250&cursor=c_1&snapshotAt=...
ETAPA 6 RESPOSTA 200 OK { data: { passes, hasMore: false } }

Padrões de Código Produtivo Multilinguagem

1. Node.js / TypeScript: Auxiliar Idempotente de Upsert de Cartão

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 Idempotente e Verificador Webhook HMAC

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: Emitir/Atualizar um Cartão e Verificar Webhooks

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: Referência Rápida de Linha de Comandos

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"
    }
  }'

Paginação de snapshots do scanner offline

GET /api/v1/scans/offline-dataset requer x-scanner-key e devolve o snapshot numa resposta com success, data e metadata. Mantenha o mesmo snapshotAt em todas as páginas.

Parâmetro / Campo de respostaTipoDescrição
limitnumberPasses por página (valor predefinido 500, máximo 1000).
cursorstringUse data.nextCursor da resposta anterior; omita-o no primeiro pedido.
snapshotAtstring (ISO 8601)Reutilize data.snapshotAt da primeira resposta como limite superior do snapshot nas páginas seguintes.
data.passesArraySnapshots de passes limitados à configuração do scanner.
data.hasMorebooleanContinue a obter páginas enquanto este valor for true.
data.nextCursorstringUse como cursor quando data.hasMore for true; o campo é omitido na última página.

Explore esquemas OpenAPI em direto em /docs, teste com a nossa coleção Bruno em Testes e Depuração ou crie modelos de cartão com IA em Crie o Seu Primeiro Cartão Wallet.

Documentação de produto e API relacionada

Pronto para lançar o seu primeiro programa de cartões Wallet?

Crie o seu espaço de trabalho, configure o seu modelo e teste um cartão real na Apple Wallet e Google Wallet antes de escalar.