Documentação para desenvolvedores

API PartsGov

Integre o ERP do órgão à plataforma com endpoints REST, autenticação por Bearer Token e respostas em JSON. Consulte o catálogo de linha pesada direto do seu sistema.

Autenticação segura

Acesso via Bearer Token com controle granular de permissões e expiração configurável por aplicação.

Alta performance

Respostas otimizadas e cache inteligente para consultas rápidas, mesmo em grandes volumes de dados.

Fácil integração

Padrão RESTful com respostas em JSON e códigos HTTP semânticos — integração direta com qualquer linguagem.

1Autenticação

Todas as requisições à API devem ser autenticadas por um Bearer Token enviado no cabeçalho da requisição.

Header
Authorization: Bearer seu_token_aqui
Nota: para obter seu token de acesso, entre em contato com nossa equipe de suporte ou acesse o painel administrativo.

2Buscar peças

GET /v1/pecas/search Estável

Busca peças no catálogo utilizando descrição, part number ou código OM — incluindo itens de linha pesada, agrícola e amarela, com equivalências similares.

Parâmetros da requisição

ParâmetroTipoObrigatórioDescrição
descricaostringCondicional*Descrição da peça (mín. 4 caracteres)
codigo_partnumberstringCondicional*Código Part Number
codigo_omstringCondicional*Código OM
pageintNãoNúmero da página (padrão: 1)

* Pelo menos um dos parâmetros condicionais deve ser enviado.

Exemplo de requisição

cURL
curl -X GET "https://partsgov.com.br/api/v1/pecas/search?descricao=lona+de+freio&page=1" \
  -H "Authorization: Bearer seu_token_aqui" \
  -H "Accept: application/json"

Exemplo de resposta

200 · application/json
{
  "success": true,
  "message": "Busca realizada com sucesso.",
  "data": {
    "pecas": [
      {
        "id": 1,
        "descricao": "Lona de Freio Traseira",
        "codigo_partnumber": "3090253022",
        "codigo_om": "OM456",
        "montadora": "MERCEDES-BENZ",
        "preco": "418.00"
      }
    ],
    "pagination": {
      "total": 50,
      "per_page": 15,
      "current_page": 1,
      "last_page": 4
    }
  }
}

3Códigos de status

200OK · Requisição processada com sucesso
400Bad Request · Parâmetros inválidos
401Unauthorized · Token inválido ou ausente
500Internal Server Error · Erro no servidor

4Boas práticas

Segurança

Nunca exponha seu token em repositórios públicos ou no lado do cliente. Use variáveis de ambiente.

Cache

Implemente cache local para resultados frequentes — reduz a latência percebida e o consumo de requisições.

Tratamento de erros

Sempre verifique o campo success na resposta e trate os códigos HTTP adequadamente.

Paginação

Utilize o parâmetro page para percorrer grandes volumes de dados de forma eficiente.

Precisa de credenciais de acesso?

Fale com nossa equipe técnica: geramos o token, definimos as permissões e acompanhamos a integração.

Solicitar acesso à API