A API de assinatura eletrônica Certyneo no Postman
Importe a coleção pública Certyneo no Postman e teste cada endpoint da API REST v1 — criação de envelopes, envio, acompanhamento de status, webhooks — com exemplos de requisições já preenchidos.
Coleção gratuita e pública. Uma chave API Certyneo é necessária para executar as requisições.
Por que usar a coleção Postman Certyneo
A coleção foi criada para desenvolvedores que querem explorar a API Certyneo sem ler toda a documentação antes de lançar sua primeira requisição.
Requisições prontas para usar
Cada endpoint da API REST v1 é documentado com um exemplo de requisição e resposta, pronto para executar após preencher sua chave API.
Ambientes de teste
Uma variável de ambiente Postman contém sua chave API e a URL base, para alternar facilmente entre suas contas ou ambientes.
Documentação gerada automaticamente
A documentação Postman da coleção permanece sincronizada com a spec OpenAPI da API Certyneo — sem defasagem entre o que você testa e o que está em produção.
Testar sem escrever código
Crie um envelope, envie-o e acompanhe seu status diretamente pela interface Postman, antes mesmo de integrar a API em sua aplicação.
O que a coleção cobre
Uma visão geral dos grupos de endpoints disponíveis na coleção pública.
| Grupo | O que contém |
|---|---|
| Envelopes | Criar, enviar, listar, consultar e cancelar um envelope de assinatura. |
| Documentos | Fazer upload de um documento ou importá-lo de uma URL (sourceUrl), consultar seu status. |
| Signatários | Adicionar destinatários, definir sua ordem de assinatura e seu nível (SES/AES). |
| Webhooks | Criar e gerenciar assinaturas para eventos de assinatura. |
| Envio em massa | Enviar vários envelopes em uma única requisição para campanhas de assinatura em volume. |
A coleção é pública para leitura: você pode consultá-la sem conta, mas a execução de requisições requer uma chave API Certyneo válida.
Comece com a coleção em 4 etapas
Menos de 5 minutos são suficientes para enviar sua primeira requisição.
- 1
Importar a coleção pública
No Postman, abra a coleção pública Certyneo e clique em « Fork » ou « Import » para copiá-la para seu próprio espaço.
- 2
Gerar uma chave API Certyneo
No seu painel de controle Certyneo, abra Configurações → Chaves API e crie uma chave dedicada ao Postman.
- 3
Preencher a variável de ambiente
Cole sua chave API na variável de ambiente da coleção Postman, junto com a URL de base da API.
- 4
Enviar uma primeira requisição
Inicie a requisição « Criar um envelope » e acompanhe o resultado diretamente no Postman.
Segurança e boas práticas
As requisições da coleção passam pela mesma API que sua aplicação em produção: as mesmas regras de segurança se aplicam.
- Todas as requisições são transmitidas em HTTPS/TLS 1.2 no mínimo.
- Cada chave API é limitada às permissões que você concede no momento da criação.
- Use uma chave de teste dedicada para seus testes no Postman, distinta de sua chave de produção.
- Uma chave API comprometida ou não utilizada pode ser revogada em um clique no seu painel de controle Certyneo.
Perguntas frequentes
É necessário um plano pago para usar a coleção Postman?
Não. A coleção é pública e gratuita. Os limites do seu plano Certyneo (número de envelopes, funcionalidades) aplicam-se às solicitações executadas, como para qualquer uso da API.
Onde encontrar minha chave API?
No seu painel Certyneo, em Configurações → Chaves API. Crie uma chave dedicada aos seus testes Postman.
A coleção está atualizada com a versão mais recente da API?
Sim, a coleção é regenerada a partir da especificação OpenAPI oficial da API Certyneo a cada evolução da API REST v1.
Posso testar os webhooks a partir do Postman?
Sim, a coleção contém os endpoints para criar e listar suas assinaturas webhooks. Para receber os eventos localmente, use um serviço de túnel HTTP durante seus testes.
O uso da coleção Postman tem um custo?
Não, apenas o consumo da API em si (criação de envelopes) é deduzido do seu plano, exatamente como uma chamada API clássica.
Para saber mais
Teste a API Certyneo no Postman
Coleção pública, gratuita, sincronizada com nossa documentação para desenvolvedores.