Criando um documento

Home Painel Chaves de API

Search…

Introdução

Sobre o GraphQL

Integrando com a API

Usando o Altair

Criando um documento

Assinando um documento

Resgatando documentos

Criando pastas

Movendo documento para pasta

Sandbox/testes

Mensagens de erro

Webhooks

Criando um documento

Como criar um documento/enviar um documento para assinatura.

A criação de documentos difere um pouco das outras mutations por ter o upload de um arquivo. Primeiramente, vamos precisar escrever a mutation:
1
mutation CreateDocumentMutation(
2
  $document: DocumentInput!, # Definição das variáveis $document,
3
  $signers: [SignerInput!]!, # $signers e $file, com seus respectivos
4
  $file: Upload!             # tipos. (Os "!" indicam que são
5
) {                          # parâmetros obrigatórios)
6
  createDocument(
7
    document: $document, # Passa para os parâmetros da mutation o 
8
    signers: $signers,   # valor das variáveis.
9
    file: $file          #
10
  ) {
11
    id
12
    name
13
    refusable
14
    sortable
15
    created_at
16
    signatures {
17
      public_id
18
      name
19
      email
20
      created_at
21
      action { name }
22
      link { short_link }
23
      user { id name email }
24
    }
25
  }
26
}
Copied!
Após, precisamos dos valores das variáveis definidas na mutation em um JSON:
1
/*
2
  Abaixo, um signatário receberá o link de assinatura por email,
3
  por ter sido passado o "email" e, para o que passou "name",
4
  será retornado o atributo "link" no documento com o link de
5
  assinatura.
6
*/
7
​
8
{
9
  "document": {
10
    "name": "Contrato de marketing"
11
  },
12
  "signers": [{
13
    "email": "[email protected]",
14
    "action": "SIGN"
15
  }, {
16
    "name": "Ronaldo Fuzinato",
17
    "action": "SIGN"
18
  }]
19
}
Copied!
Percebeu que não foi colocado nenhum valor para a variável $file? Pois é, como é realizado o upload desse arquivo, a requisição precisa ser enviada como multipart/form-data, dessa forma o arquivo precisa ser um pouco diferente. Você pode fazer isso direto no Altair:
Você pode conferir o que é cada um desses parâmetros direto na documentação completa da API GraphQL, no menu Docs do Altair. Se você não sabe como fazer isso, confira o nosso tutorial:
Caso você esteja em dúvida de como funciona o envio do documento para usar na sua integração, este repositório fornece mais informações e exemplos de como fazer o upload: https://github.com/jaydenseric/graphql-multipart-request-spec​
Autentique v2.postman_collection.json
19KB
Binary
Para importar e usar no Postman

Integrando com a API - Previous

Usando o Altair

Next - Integrando com a API

Assinando um documento

Last modified 11mo ago

Copy link