Resgatando documentos

Quase tudo o que você precisa saber para listar ou buscar documentos específicos de um usuário.
Evite utilizar estes métodos para consultar o status das assinaturas frequentemente. Os webhooks são uma forma mais rápida e eficiente de fazer isso (e o nosso backend agradece 😅 )
Webhooks
/integracao/webhooks
Resgatando um documento específico
No Altair, você pode testar com o item Resgatar documento da collection pronta. Não esqueça de completar a query com o ID de um documento existente para buscar:
query {
  document(id: "ID_DO_DOCUMENTO") {
    id
    name
    refusable
    sortable
    created_at
    files { original signed }
    signatures {
      public_id
      name
      email
      created_at
      action { name }
      link { short_link }
      user { id name email }
      email_events {
        sent
        opened
        delivered
        refused
        reason
      }
      viewed { ...event }
      signed { ...event }
      rejected { ...event }
    }
  }
}
​
fragment event on Event {
  ipv4
  ipv6
  reason
  created_at
  geolocation {
    country
    countryISO
    state
    stateISO
    city
    zipcode
    latitude
    longitude
  }
}
Você pode conferir o resultado direto no Altair:
Da mesma forma, você pode usar fragments como uma forma de evitar repetição nas queries com o GraphQL.
Você também pode consultar vários documentos ao mesmo tempo:
query {
  primeiro: document(id: "ID_DO_DOCUMENTO_1") { name }
  segundo: document(id: "ID_DO_DOCUMENTO_2") { name }
  terceiro: document(id: "ID_DO_DOCUMENTO_3") { name }
}
E, assim como mostra na imagem acima, você também pode nomear as queries. (OBS: O nome não pode conter somente números)
Listando documentos
Também é possível retornar páginas contendo múltiplos documentos:
query {
  documents(limit: 60, page: 1) {
    total
    data {
      id
      name
      refusable
      sortable
      created_at
      signatures {
        public_id
        name
        email
        created_at
        action { name }
        link { short_link }
        user { id name email }
        viewed { created_at }
        signed { created_at }
        rejected { created_at }
      }
      files { original signed }
    }
  }
}
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:
Usando o Altair
/integracao/altair
Se o Altair não te ajuda para integrar com a API, confira alguns exemplos de como fazer essas requisições de outra forma: https://graphql.org/graphql-js/graphql-clients/​
Para importar e usar no Postman
Autentique v2.postman_collection.json - 12KB
Integrando com a API - Previous
Assinando um documento
Next - Integrando com a API
Criando pastas
Last updated 2 months ago