API Pública

Bem-vindo à documentação da API. Esta API fornece informações referentes a plataforma de PITOM84.

URL BASE

https://api.pitom.com.br/api/v2/

Para mais informações técnicas clique aqui. | OPENAPI.JSON

ENDPOINTS

api/v2/store
api/v2/appraisal/history
api/v2/appraisal/client
api/v2/appraisal/upload
api/v2/setup/reason
api/v2/setup/conservation
api/v2/setup/files

Observação: para acesso as rotas apresentadas é necessário apresentar uma chave única vinculada ao usuário.

EXEMPLO DE RESPOSTAS

/*api/v2/store*/
{
  "isArray": true,
  "length": 0,
  "path": "string",
  "duration": "string",
  "method": "string",
  "data": {
    "id": 0,
    "name": "string"
  }
}

/*api/v2/appraisal/history*/

{
  "isArray": true,
  "length": 0,
  "path": "string",
  "duration": "string",
  "method": "string",
  "data": {
    "store_id": 0,
    "store": {
      "id": 0,
      "name": "string",
      "business": {
        "name": "string"
      }
    },
    "seller_user": {
      "email": "string",
      "cpf": "string",
      "name": "string"
    },
    "appraisal_id": "string",
    "appraisal_status": "string",
    "appraisal_active_status": true,
    "appraisal_status_description": "string",
    "appraisal_updated": "2024-05-27T20:02:28.696Z",
    "appraisal_created": "2024-05-27T20:02:28.696Z",
    "appraisal_active": true,
    "appraiser_observation": "string",
    "appraisal_preserved": "string",
    "appraisal_reason_sell": "string",
    "appraisal_rated": 0,
    "appraisal_rated_message": "string",
    "appraisal_desired": 0,
    "appraisal_sketch": true,
    "appraisal_market": true,
    "vehicle_brand": "string",
    "vehicle_model": "string",
    "vehicle_license_plate": "string",
    "vehicle_km": 0,
    "vehicle_year": 0,
    "client_name": "string",
    "client_phone": "string",
    "value_fipe": 0,
    "value_pitom84": 0,
    "appraiser_user": {
      "email": "string",
      "cpf": "string",
      "name": "string"
    }
  }
}

/*POST*/
{
"client": CLIENT_OBJECT,
"license_vehicle": "PLACA",
"km": "integer value",
"reason": "from list", 
"desired_value": "integer number", 
"conservation": "from list", 
"store": "id da loja", 
"user": "e-mail do usuario", 
"integration": {"tool": "salesforce", 
"values": [{"salesforceid": "id transaction"}]}
}


/*Retorno: api/v2/appraisal/client*/
{
"appraisal_id": "id"
}

/*api/v2/appraisal/upload*/
{
"file": "binary", 
"fileName": "from list", 
"folder": "appraisal_id", 
"metadata": "meta image"
}

/*api/v2/setup/reason*/
[{"id": "reason_id", "description"}]

/*api/v2/setup/conservation*/
[{"id": "conservation_id", "description"}]

/*api/v2/setup/files*/
[{"id": "file_id", "description"}]

ERROS

A API retorna os seguintes códigos de status HTTP em caso de erros:

400 Bad Request: Requisição inválida.
401 Unauthorized: Falha na autenticação ou falta de credenciais.
404 Not Found: Recurso não encontrado.
500 Internal Server Error: Erro interno do servidor.

Para mais detalhes sobre os códigos de erro específicos, consulte a resposta de erro retornada pela API.

LIMITE DE USO

COMERCIAL

A API atualmente não possui limites de uso, no entanto, isso pode mudar no futuro. Certifique-se de verificar nossa política de uso para obter informações atualizadas.

TÉCNICO

500 chamadas por minuto.
Range de 31 dias por chamada.

CONTATO

Se você tiver dúvidas ou problemas, entre em contato conosco em suporte@pitom.com.br