Sandbox/testes

Uma bela ajuda para realizar testes na plataforma sem custos adicionais ou gastar os documentos grátis.

Para contextualizar, recomendamos que você leia como funciona a criação e a listagem de documentos primeiro:

Criando um DocumentoResgatando Documentos

Criando documentos sandbox

A criação de documentos teste depende apenas de um atributo a ser informado no documento: "sandbox".

mutation CreateDocumentMutation(
  ...
) {
  createDocument(
    sandbox: true,
    document: $document,
    signers: $signers,
    file: $file
  ) {
  ...
  }
}

Feito! Os documentos criados com sandbox não irão gastar créditos porém, por serem de teste, serão excluídos após alguns dias.

Enquanto eles não forem excluídos, você poderá vê-los nas listagens de documentos do painel se você ativar na página de chaves de API:

Resgatando documentos sandbox

Assim como no painel, a listagem de documentos não retorna por padrão documentos que foram criados em sandbox. Para isso, existem duas flags que habilitam esse comportamento.

Habilitando a listagem de documentos sandbox

Para permitir que a listagem de documentos também retorne documentos que foram criados no modo sandbox, é necessário passar a flag showSandbox nos parâmetros da query:

query {
  documents(
    limit: 60, 
    page: 1,
    showSandbox: true
  ) {
  ...
  }
}

Listando exclusivamente documentos sandbox

Também é possível buscar apenas por documentos que foram criados em sandbox. Para isso, basta passar a flag onlySandbox nos parâmetros da query.

query {
  documents(
    limit: 60, 
    page: 1,
    onlySandbox: true
  ) {
  ...
  }
}

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 em Usando o Altair

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

19KB

Autentique v2.postman_collection.json

Para importar e usar no Postman