Guia Completo: Como usar o Módulo Make a API Call com a ZapSign!

A integração de serviços por meio de APIs é essencial para otimizar processos e automatizar tarefas repetitivas. Com o módulo Make a API Call da plataforma Make, é possível interagir diretamente com a API da ZapSign para criar documentos, recuperar informações e muito mais. Este guia traz um passo a passo detalhado para você realizar essa configuração com facilidade.

Requisitos Necessários

• Plano API ativo e vigente na ZapSign;

• Conta criada na plataforma Make;

• Conhecimento básico em programação e familiaridade com APIs;

• Consulta à documentação da API da ZapSign (Acesse aqui).

Passo a passo para configurar o Módulo

Criar um Novo Cenário no Make:

1. Primeiro será preciso acessar sua conta no Make (clique aqui para se cadastrar).
2. Na tela inicial do Make, vá em “+ Create New Scenario”.
   
   
3. Após acessar a tela de New Scenario, pesquise por Zapsign no campo de busca de módulos/apps e selecione o módulo Make a API call.
   
   

Configurar a conexão com a API da ZapSign:

1. Você irá visualizar a tela de conexão (Connection). Selecione Create a Connection e preencha o nome que você deseja colocar para sua conexão em Connection name (nome da conexão). Depois, insira seu API TOKEN no campo abaixo destinado ao token. 
   
   

Definir a URL e o método HTTP:

1. Após finalizar a conexão, você irá preencher os campos que o módulo disponibiliza.
2. Primeiro, cole a URL que deseja utilizar. Uma URL em API é o endereço que você usa para se conectar a um serviço e pedir ou enviar informações. Ela funciona como um "caminho" para acessar um recurso específico na API.
   
   Essas são algumas URLs disponíveis em nossa documentação:
   https://api.zapsign.com.br/api/v1/docs (Criar documento via Upload);
   https://api.zapsign.com.br/api/v1/models/create-doc/ (Criar documento via Modelo);
   https://api.zapsign.com.br/api/v1/docs// (Detalhar documento). 
   
   Nesse exemplo, a URL utilizada será a de Criar documento via Upload. Lembrando que você pode consultar todas as informações acessando a documentação em nosso site: https://docs.zapsign.com.br/
   
   
   
   

3. No campo Method (método) você irá escolher a forma de dizer à API o que você quer fazer. Trabalhamos com uma API REST, que utiliza os métodos GET e POST:

   GET: Usado para buscar informações.

   POST: Usado para enviar informações.

   Cada endpoint tem um método específico definido na documentação da AP

   Em nossa documentação, está especificado qual é o método de cada URL. Nesse exemplo, o método da URL de Criar documento via Upload é POST.
    

   

Configurar o corpo da requisição (Body):

1. O campo Headers já virá preenchido automaticamente. Você NÃO precisa adicionar cabeçalhos de autorização, pois já fizemos isso para você.
   
   Lemos tudo em JSON e nossas respostas também são em JSON, então mantenha esses campos com as informações que já vieram de forma automática: 
   Key: Content-Type
   Value: application/json
   
   

2. O campo Query String não é necessário nesse módulo, então você pode desconsiderá-lo e passar para a próxima etapa
   
   

3. Por fim, no campo Body você irá inserir o conteúdo de sua requisição que será enviado para API. Para facilitar, nós da ZapSign deixamos todas as requisições prontas no Postman para você economizar tempo.

   Acessando o site https://docs.zapsign.com.br/todas-as-requisicoes-prontas você poderá acessar a requisição que deseja utilizar. 

   Nesse exemplo, o body utilizado será da requisição Criar documento via Upload. Acesse o site de nossa documentação onde disponibilizamos as requisições, e clique em Public API | Zapsign Public Workspace. 

   Após isso, você será direcionado ao nosso espaço de trabalho no Postman, onde todas as requisições estarão disponíveis. Selecione a requisição de Criar documento via Upload, clique em body e copie todo o conteúdo da requisição. Depois, retorne ao MAKE e cole essa requisição.

   DICA: Cole o texto sem formatação. Para isso, utilize as teclas Ctrl + Shift + V ou clique com o botão direito do mouse e selecione “colar como texto sem formatação”.

    

Executar a chamada na API:

1. Com todas as informações preenchidas nos respectivos campos, agora só é necessário “rodar” o módulo. Para isso, clique no botão Run Once. Se tudo for feito corretamente, o módulo irá carregar e ficará com ícones verdes, o que significa que todas as informações foram processadas e o documento foi criado.
   
   
2. Por fim, é importante ressaltar que você pode (e deve) editar as requisições conforme a sua necessidade. No tópico acima, a requisição de Criar documento via Upload foi copiada exatamente da mesma forma que é disponibilizada em nossa biblioteca. Abaixo, traremos um exemplo de requisição editada.
   
   

3. Nota-se que a requisição editada está consideravelmente menor que a original. Isso ocorre pois na requisição editada, não utilizamos todas as strings disponíveis (Veja todas as strings disponíveis no link https://docs.zapsign.com.br/documentos/criar-documento). 

   Utilizamos somente as strings necessárias para a criação desse documento, que foram:

       
       Assim, o documento será criado somente com essas condições. Veja abaixo:
       

Dúvidas? Consulte a Inteligência Artificial da ZapSign!

Se tiver dificuldades, utilize a assistente de IA treinada com toda a documentação da API. Acesse este link para tirar suas dúvidas de forma rápida e eficiente!