Skip to content

Arquivos de documentação para integração com os serviços da Clicksign

Notifications You must be signed in to change notification settings

clicksign/docs-clicksign-api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 

Repository files navigation

API Collections para Testes

Este repositório contém collections para facilitar o teste e a integração com a API da Clicksign. As collections estão disponíveis para as ferramentas Postman e Insomnia e foram criadas para ajudar desenvolvedores a entender e interagir com os endpoints da API de maneira prática e eficiente.


Conteúdo do Repositório

  • Postman Collection: Arquivo JSON das collections que pode ser importado diretamente no Postman.
  • Postman Environment: Arquivo JSON das variáveis de ambiente que pode ser importado diretamente no Postman.
  • Insomnia Collection: Arquivo YAML das collections que pode ser importado diretamente no Insomnia.

Como Usar as Collections

Postman

  1. Faça o download do arquivo Clicksign_Postman_Collection.json.
  2. Abra o Postman.
  3. Vá até o menu File > Import.
  4. Selecione o arquivo baixado e importe.
  5. Importe também as variáveis de ambiente Clicksign_Postman_Environment.json.

Insomnia

  1. Faça o download do arquivo Clicksign_Insomnia_Collection.yaml.
  2. Abra o Insomnia.
  3. Clique no menu de Workspaces e selecione Import/Export > Import Data.
  4. Escolha a opção From File e selecione o arquivo baixado.

Configuração da API Key

Ambas as collections requerem uma API Key válida para autenticação. Certifique-se de seguir as etapas abaixo:

  1. No Postman ou Insomnia, localize o ambiente configurado ou os headers de autenticação da request.
  2. Substitua access_token pelo seu token de autenticação.

Estrutura das Requests

As collections incluem exemplos de requisições para:

  • Criar envelopes.
  • Adicionar documentos.
  • Configurar signatários.
  • Outras operações da API.

Atualizações e Contribuições

Se houver atualizações ou melhorias nas collections, elas serão refletidas neste repositório.
Contribuições são bem-vindas! Sinta-se à vontade para abrir issues ou enviar PRs.


Suporte

Se você tiver dúvidas sobre como usar as collections ou a API, entre em contato pelo e-mail ajuda@clicksign.com.


Happy Coding! 🚀

About

Arquivos de documentação para integração com os serviços da Clicksign

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published