Aqui você encontrará informações sobre as requisições disponíveis, os parâmetros necessários para cada requisição e exemplos de uso.
Informações importantes:

• Para acessar as requisições da API, você precisa de um token de autorização.
• A requisição deverá ser feita no formato do GraphQL.
• todas as requisições são realizadas no mesmo endpoint, o que diferencia a informação requisitada é o corpo da requisição.
• Todas as requisições devem ser do tipo POST.

Para acessar as requisições da API, você precisará fornecer um token de autorização. Este token deverá ser enviado no header da requisição, no formato
x-token: seu_token.

Para gerar um token de acesso siga os passos abaixo:

1. Na página do Doma ERP, acesse configurações.
2. Acesse o "Compartilhamento e Acesso a Terceiros" e clique em Criar novo token.
3. Após preencher as informações necessárias, clique em Confirmar.
4. O token criado irá aparecer na listagem.

Nossa API GraphQL utiliza 2 operações principais, são elas:

• Query: utilizada para consultas, ou seja, para buscar informações.
• Mutation: utilizada para criar, alterar ou excluir informações.

O GraphQL também possui um sistema de tipagem, ou seja, cada campo possui um tipo de dado específico, e você pode consultar a documentação para saber quais são esses tipos.

Requisições: A API possui um limite de 25 requisições a cada 5 segundos. Caso esse limite seja ultrapassado, o envio de novas requisições ficará bloqueado por 5 minutos.

Paginação: Consultas que possuem a variável paginação, obrigatoriamente deverá ser preenchida. Caso contrário, o sistema retornará um erro. O limite máximo de registros por página é 200.

Para fazer uma requisição, é necessário enviar um POST, com o conteúdo que deseja consultar no body da requisição.

A requisição da API Doma é composta por 3 partes, a operação, o input e o output.

• Na operação você deve informar o tipo de operação que deseja fazer, podendo ser uma query ou uma mutation.
• O input é o que você deseja de retorno da operação, ele pode ser um ou mais campos da operação, a operação pode ou não ter parâmetros, e esses parâmetros podem ser obrigatórios ou não, na documentação você encontra a informação de quais são os parâmetros obrigatórios.
• O output é o que deseja receber, ele pode ser um ou mais campos, e você pode escolher quais campos deseja receber. Nossas mutations tem um retorno padrão, que é o ID do registro cadastrado.

Aqui está 2 exemplos de requisição, um de uma query(consulta) e outro de uma mutation(criação, alteração ou exclusão).
Exemplo do body de requisição de uma query:

  { 
   "variables":{ 
    "filtro":{ 
     "IdVendedor":6 
    } 
   }, 
   "query":"query 
Metas($filtro: InputFiltroMetas) { 
    metas(Filtro: $filtro) { 
     Id 
     IdVendedor 
     NomeVendedor 
     NomeMeta 
     ValorMeta 
     TipoBonificacao 
     ValorBonificacao 
     Status 
    } 
   }" 
 }  

Exemplo de mutation:

  { 
   "variables":{ 
    "dados":{ 
     "NomeMeta":"Meta Geral", 
     "IdVendedor":null, 
     "ValorMeta":10000, 
     "ValorBonificacao":50, 
     "TipoBonificacao":"VALOR", 
     "Status":"ATIVO" 
    }, 
   }, 
   "query":"mutation 
CadastraMeta($dados: InputCadastrarMeta!) { 
    cadastraMeta(Dados: $dados) 
   }" 
 }  

Exemplo de requisição:

  POST / HTTP/1.1 
 Host: https://api.domagestao.com.br:3000/ 
 Content-Type: application/json 
 x-token: seu_token 
 { 
   "variables":{ 
    "filtro":{ 
     "IdVendedor":6 
    } 
   }, 
   "query":"query 
Metas($filtro: InputFiltroMetas) { 
    metas(Filtro: $filtro) { 
     Id 
     IdVendedor 
     NomeVendedor 
     NomeMeta 
     ValorMeta 
     TipoBonificacao 
     ValorBonificacao 
     Status 
    } 
   }" 
 }  

Uma chamada com sucesso retornará um código 200 e um objeto JSON com os dados solicitados.
Exemplo de retorno:

  { 
   "data": { 
    "metas": [ 
     { 
      "Id": 1, 
      "IdVendedor": null, 
      "NomeVendedor": null, 
      "NomeMeta": "Meta Geral", 
      "ValorMeta": 10000, 
      "TipoBonificacao": "VALOR", 
      "ValorBonificacao": 50, 
      "Status": "ATIVO", 
     }, 
    ] 
   } 
 }  

Nas queries que suportam paginação, caso os parâmetros de paginação não sejam especificados, o sistema retornará por padrão os 10 primeiros registros.

Caso ocorra um erro, a API retornará um código 400 e um objeto JSON com a mensagem de erro.
Exemplo de retorno de erro:

  { 
   "errors": [ 
    { 
     "message": "Mensagem de erro", 
     "field": "campo com erro" 
    } 
   ] 
 }  

A partir de agora você verá todas as Querys (consultas) e Mutations disponíveis, navegue pelo menu de acesso para encontrar as operações desejadas.