Skip to content
Referência da API REST e SDKs

Documentação para Desenvolvedores Passinstance

Crie integrações em grande escala para Apple Wallet (.pkpass) e Google Wallet. Emita, atualize, valide e transmita notificações em tempo real através de APIs REST prontas para produção.

Obter chaves de API
Bancada interativa — os trechos são atualizados enquanto você digita

Gestão de pacotes

4 endpoints
POSThttps://api.passinstance.com/api/v1/bundles/upsertChave de API
Gestão de pacotes

Criar ou atualizar pacote de passes

Crie ou atualize um pacote multipasse (.pkpasses) que permite aos usuários instalar vários passes relacionados com um único toque.

Cabeçalhos1 obrigatório(s)
X-API-Keystring
Obrigatório

Chave de API secreta do workspace (pi_live_... ou pi_test_...). Alternativamente, envie Authorization: ApiKey <key>.

Exemplo: pi_live_98a7b6c5d4e3f2a1

Array of pass UUIDs (up to 10) and optional existing bundleId.

Corpo da requisição1 obrigatório(s) • 1 opcional(is)
passesstring[] (UUID)
Obrigatório

Lista de 1 a 10 UUIDs de passes para agrupar no pacote.

Exemplo: ["b1d972dc-eccf-4f87-ab21-25939d9213d8", "c2e083ed-fddf-4a98-bc32-36040e0324e9"]

Códigos de status de resposta

GEThttps://api.passinstance.com/api/v1/bundles/{id}/passesChave de API
Gestão de pacotes

Listar passes no pacote

Liste todos os passes individuais atualmente associados a um pacote de passes, incluindo status e números de série.

Cabeçalhos1 obrigatório(s)
X-API-Keystring
Obrigatório

Chave de API secreta do workspace (pi_live_... ou pi_test_...). Alternativamente, envie Authorization: ApiKey <key>.

Exemplo: pi_live_98a7b6c5d4e3f2a1
Parâmetros de caminho1 obrigatório(s)
idstring (UUID)
Obrigatório

UUID do pacote de passes.

Exemplo: e5f6a7b8-c9d0-4e1f-8a2b-3c4d5e6f7a8b
Parâmetros de consulta3 opcional(is)

Códigos de status de resposta

POSThttps://api.passinstance.com/api/v1/bundles/{id}/voidChave de API
Gestão de pacotes

Anular passes do pacote

Anule ou reative todos os passes pertencentes a um pacote de passes em uma única operação.

Cabeçalhos1 obrigatório(s)
X-API-Keystring
Obrigatório

Chave de API secreta do workspace (pi_live_... ou pi_test_...). Alternativamente, envie Authorization: ApiKey <key>.

Exemplo: pi_live_98a7b6c5d4e3f2a1
Parâmetros de caminho1 obrigatório(s)
idstring (UUID)
Obrigatório

UUID do pacote de passes.

Exemplo: e5f6a7b8-c9d0-4e1f-8a2b-3c4d5e6f7a8b

Confirmation flag and optional audit reason for voiding all passes in the bundle.

Corpo da requisição1 obrigatório(s) • 1 opcional(is)
voidedboolean
Obrigatório

Deve ser definido como true para anular todos os passes do pacote.

Exemplo: true

Códigos de status de resposta

DELETEhttps://api.passinstance.com/api/v1/bundles/{id}Chave de API
Gestão de pacotes

Excluir pacote de passes

Exclua um agrupamento de pacote de passes do seu workspace.

Cabeçalhos1 obrigatório(s)
X-API-Keystring
Obrigatório

Chave de API secreta do workspace (pi_live_... ou pi_test_...). Alternativamente, envie Authorization: ApiKey <key>.

Exemplo: pi_live_98a7b6c5d4e3f2a1
Parâmetros de caminho1 obrigatório(s)
idstring (UUID)
Obrigatório

UUID do pacote de passes a ser excluído.

Exemplo: e5f6a7b8-c9d0-4e1f-8a2b-3c4d5e6f7a8b

Códigos de status de resposta