Documentação API

**Padrão GraphQL **

A API de acesso ao tecnoJURIS utiliza o padrão GraphQL, que é uma linguagem de consulta criada pelo Facebook. É considerada uma alternativa para arquiteturas REST, além de oferecer um serviço runtime para rodar comandos e consumir uma API.

Autenticação

Para acessar a API, o primeiro passo é gerar um token de autenticação que permitirá a aplicação dos comandos. Esse token será utilizado no header das requests subsequentes.

Utilizando o Postman ou outro software de sua preferencia, irá montar a seguinte requisição:

curl -X POST \

__ https://nome_da_conta.tecnojuris1.com.br/usuarios/sign_in.json __

-H 'Accept: application/json' \ -H 'Content-Type: application/json' \

-d '{"usuario": { "email": "email_usuario", "password": "senha_usuario", "subdomain": "nome_da_conta"} }'

**Campos que devem ser preenchidos: **

• nome_da_conta - início da URL da conta. Exemplo: escritório.tecnojuris1.com.br, nesse caso o nome da conta seria: escritório.
• email_usuario - e-mail do usuário com acesso ao sistema
• senha_usuario - senha do usuário
• nome_da_conta - repete a informação do primeiro item

Exemplo:

Como utilizar o token

Após a geração do token recomendamos utilizar o Software Altair para fazer as requisições, pois com ele podem gerar uma documentação virtual completa de toda a estrutura da API, podendo visualizar as chamadas disponíveis, filtros, campos e subcampos.

O token deve ser inserido no HEADER no formato:

Header key: AUTH_TOKEN

Header value: token informado no passo anterior

Ponto de entrada

O ponto de entrada das chamadas GraphQL será a URL:

https://nome_da_conta.tecnojuris1.com.br/graphql

Lembrando de substituir “nome_da_conta” pelo inicio da URL da conta como fizemos na etapa anterior.

Teste da configuração

Rode a query:

Substitua pessoa_id por um ID de pessoa válido para sua conta. 
query{ 
     pessoasConnection(pessoaId: "pessoa_id")
          { nodes{ 
               nome }
          }     
 }

Resultado:

{

 "data": 
     { "pessoasConnection": 
          { "nodes": [ 
               { "nome": "Nome da Pessoa" } 
          ] } 
     } 
}

Estrutura Documentação Altair

Como abordado anteriormente pelo Altair é possível gerar uma documentação completa da estrutura, para fazer isso basta clicarmos em “Docs” na parte superior direita da tela.

Em “Query” temos as requisições de extração de dados.

Em “Mutation” temos as requisições de mutação de dados(Cadastro, alteração e exclusão).

Ao acessar a requisição desejada para verificar os filtros disponíveis basta verificar os “Arguments” e os campos e subcampos acessaremos os “Nodes”

Exemplo:

Atualizado em: 19/03/2026