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
😅
)

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:
1
query {
2
document(id: "ID_DO_DOCUMENTO") {
3
id
4
name
5
refusable
6
sortable
7
created_at
8
files { original signed }
9
signatures {
10
public_id
11
name
12
email
13
created_at
14
action { name }
15
link { short_link }
16
user { id name email }
17
email_events {
18
sent
19
opened
20
delivered
21
refused
22
reason
23
}
24
viewed { ...event }
25
signed { ...event }
26
rejected { ...event }
27
}
28
}
29
}
30
31
fragment event on Event {
32
ip
33
port
34
reason
35
created_at
36
geolocation {
37
country
38
countryISO
39
state
40
stateISO
41
city
42
zipcode
43
latitude
44
longitude
45
}
46
}
Copied!
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:
1
query {
2
primeiro: document(id: "ID_DO_DOCUMENTO_1") { name }
3
segundo: document(id: "ID_DO_DOCUMENTO_2") { name }
4
terceiro: document(id: "ID_DO_DOCUMENTO_3") { name }
5
}
Copied!
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:
1
query {
2
documents(limit: 60, page: 1) {
3
total
4
data {
5
id
6
name
7
refusable
8
sortable
9
created_at
10
signatures {
11
public_id
12
name
13
email
14
created_at
15
action { name }
16
link { short_link }
17
user { id name email }
18
viewed { created_at }
19
signed { created_at }
20
rejected { created_at }
21
}
22
files { original signed }
23
}
24
}
25
}
Copied!
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:
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/
Autentique v2.postman_collection.json
19KB
Binary
Para importar e usar no Postman
Last modified 3mo ago