Documentação para desenvolvedores

API PartsGov

Integre seus sistemas internos à plataforma com endpoints REST, autenticação por Bearer Token e respostas em JSON. Documentação completa, exemplos práticos e suporte dedicado.

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 através de um Bearer Token enviado no cabeçalho da requisição.

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

Realiza a busca de peças no banco de dados utilizando filtros específicos.

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 -X GET "https://partsgov.com.br/api/v1/pecas/search?descricao=filtro+oleo&page=1" \
  -H "Authorization: Bearer seu_token_aqui" \
  -H "Accept: application/json"

Exemplo de Resposta

{
  "success": true,
  "message": "Busca realizada com sucesso.",
  "data": {
    "pecas": [
      {
        "id": 1,
        "descricao": "Filtro de Óleo",
        "codigo_partnumber": "ABC123",
        "codigo_om": "OM456",
        "montadora": "FIAT",
        "preco": "45.90"
      }
    ],
    "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 para armazená-lo.

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.