SDKs, OpenAPI e Postman

OpenAPI 3.1

A especificação completa da API está em /openapi.yaml. Ela é gerada do código do Zynzap a cada versão: rotas, operações liberadas, formatos de entrada e saída e erros são exatamente os que a API aceita.

Use-a para gerar um cliente tipado na sua linguagem:

# TypeScript (tipos)
npx openapi-typescript https://docs.zynzap.com.br/openapi.yaml -o zynzap.d.ts

# Qualquer linguagem com o OpenAPI Generator (ex.: python, php, go, java, csharp, ruby)
docker run --rm -v "$PWD:/local" openapitools/openapi-generator-cli generate \
  -i https://docs.zynzap.com.br/openapi.yaml -g python -o /local/zynzap-python

Dicas para clientes gerados:

• Cada operação é POST /rpc/{Operação}; o corpo é {"request": {...}} (e billing nas pagas).
• Inteiros de 64 bits (int64) chegam como string; arquivos (bytes) vão em Base64.
• O esquema de segurança é bearerAuth (Authorization: Bearer <chave>).

Postman

Baixe a coleção zynzap-api.postman_collection.json (gerada da mesma especificação), importe no Postman e preencha as variáveis:

As requisições estão agrupadas como na referência. Nas operações pagas, rode antes Cobrança e cotações → Criar cotação com o mesmo request e cole o quoteId.

gRPC (avançado)

A API HTTP é uma porta pública para o mesmo contrato gRPC usado pelo painel. Integrações de alto volume que preferem gRPC podem usar o mesmo cabeçalho Authorization: Bearer <chave> e, em operações pagas, o metadado x-whatslab-billing-quote: <quoteId>. O arquivo .proto e uma coleção Postman gRPC acompanham o repositório do Zynzap; fale com o suporte para acesso ao endpoint gRPC.

Bibliotecas oficiais

Ainda não há SDKs oficiais publicados. Todos os exemplos desta documentação usam apenas a biblioteca padrão (ou a mais comum) de cada linguagem: cURL, JavaScript (fetch), Python (requests), PHP (ext-curl), Go (net/http), Java (java.net.http), C# (HttpClient) e Ruby (net/http).