Fundamentos para uso da API — compreenda os conceitos que estruturam a comunicação entre cliente e servidor na Sollos Consultas.

​
Conceitos Essenciais

Endpoint

Ponto de acesso a um recurso da API. Através dele, sua aplicação realiza operações como consulta, criação, atualização ou remoção de dados.

Estrutura de Dados (Schema)

Define a estrutura dos dados trafegados pela API, especificando campos, tipos de dados, obrigatoriedade e regras de validação.

Autenticação

Garante segurança no acesso aos dados através de um token enviado no header da requisição.

Status Codes

Códigos HTTP que indicam o resultado de cada operação (200, 201, 400, 401, 404, 500, etc.).

​
Métodos HTTP

Cada endpoint está associado a um método HTTP que define a ação executada:
MétodoDescrição
GETConsulta de dados
POSTCriação de novos recursos
PUTAtualização completa de um recurso
PATCHAtualização parcial
DELETERemoção de um recurso

​
Parâmetros em Requisições REST

A API segue o padrão REST, utilizando diferentes formas de envio de dados conforme o tipo de operação:
Utilizados principalmente em requisições GET para filtrar ou refinar resultados.
GET /empresas?cnpj=12345678000199
GET /empresas?cnpj=12345678000199&status=ativa
Enviados diretamente na URL para identificar um recurso específico.
GET /empresas/12345678000199
Indicado para operações que envolvem um único registro.
Enviados no corpo da requisição, geralmente em formato JSON. Utilizados em operações de criação ou atualização.
POST /empresas
{
  "cnpj": "12345678000199",
  "razaoSocial": "Empresa Exemplo LTDA"
}
Utilizados para enviar informações adicionais na requisição.
HeaderDescrição
AuthorizationToken de autenticação
Content-TypeFormato dos dados enviados (application/json)
AcceptFormato esperado da resposta
Authorization: Bearer {seu_token}
Content-Type: application/json

​
Padrão de Resposta

As respostas da API seguem um formato padronizado: 
{
  "success": true,
  "data": {},
  "error": null
}

​
Recursos Avançados

Em endpoints que retornam múltiplos registros, a paginação limita a quantidade de dados por requisição, melhorando performance.
GET /empresas?page=1&limit=10
Alguns endpoints permitem ordenar ou refinar resultados.
GET /empresas?status=ativa&sort=createdAt&order=desc
Alguns métodos HTTP possuem comportamento idempotente — podem ser executados múltiplas vezes sem alterar o resultado final.
  • GET, PUT, DELETE → idempotentes
  • POST → não idempotente
Esse conceito é importante para evitar efeitos colaterais em reenvios de requisições.
A API da Sollos Consultas foi projetada para manter consistência em endpoints, respostas e estruturas de dados, reduzindo ambiguidades e facilitando integrações. A compreensão desses conceitos é essencial para garantir uma integração estável, performática e sem retrabalho.