Manual de integrações Xerpa

Bem vindo ao manual de integração com os sistemas Xerpa. Nesta página você encontrará as informações necessárias para utilizar nossa API. Os itens abordados nesta pequena introdução incluem os métodos para autenticação da API, o ambiente para realizar os testes das requisições e exemplos de consultas na API utilizando GraphQL.

GraphQL trata-se de uma linguagem de consulta para APIs criada pelo Facebook, que permite obter toda a informação em uma única solicitação, ao contrário de uma consulta de API usando REST, que comumente requer múltiplas interações com o servidor.

Ambiente de Testes

A Xerpa fornece um ambiente de testes isolado com características semelhantes ao ambiente de produção. Nós chamamos este ambiente de sandbox.

Você pode criar uma conta em Sandbox aqui.

Um token1 criado no ambiente de sandbox não é compartilhado com o ambiente de produção e vice-versa. Portanto, sempre que desejar utilizar o ambiente sandbox você precisa registrar uma empresa e registrar um token1.

Importante

Todos os dados criados no ambiente sandbox são apagados semanalmente.

Api Playground

API Playground é uma instância do graphiql que funciona como uma ferramenta interativa no navegador para explorar uma API GraphQL. Com essa ferramenta é possível testar suas solicitações de maneira interativa e navegar pela estrutura da API.

Todos os exemplos nessa documentação podem ser usados no playground. Para isso copie a soliticação juntamente com as variáveis para os locais apropriados no graphiql.

Playground openned in sandbox


  1. Token é um código de acesso para uma determinada aplicação. Veja mais