Pular para o conteúdo principal

Quick Start

dica

Comece já e faça o seu primeiro pedido à API para obter a lista de veículos aqui.

Começar a usar a Cartrack Fleet API é simples. Esta secção apresenta um exemplo básico de como fazer a sua primeira chamada à API. Embora o exemplo use curl, uma ferramenta versátil e amplamente suportada para pedidos HTTP na linha de comandos, pode aplicar os mesmos princípios noutras linguagens e ferramentas, como Python, JavaScript ou bibliotecas HTTP.

Pré-requisitos​

Antes de avançar, confirme que tem:

  • cURL instalado: Garanta que o cURL está instalado no seu sistema. Normalmente está disponível em Unix, Linux e macOS, e também pode ser instalado no Windows.
  • Base URL e credenciais de autenticação: Vai precisar da base URL da Cartrack Fleet API e de credenciais válidas. Para orientação detalhada, consulte as páginas Authentication e Base URLs.

Fazer uma chamada à API​

Pode fazer uma chamada para obter a lista de veículos com curl desta forma:

curl --location '{baseUrl}/rest/vehicles' \
--header 'Accept: application/json' \
--header 'Authorization: Basic your_encoded_credentials'

Substitua {baseUrl} pela base URL real da Cartrack Fleet API e your_encoded_credentials pelas suas credenciais de autorização codificadas em Base64.

Entender o comando​

  • --location: Instrui o curl a seguir redirecionamentos enviados pelo servidor.
  • --header: Permite definir cabeçalhos adicionais no pedido. Neste exemplo, indicamos que aceitamos respostas em JSON e incluímos as credenciais de autorização.
  • O URL do endpoint ({baseUrl}/rest/vehicles) identifica o endpoint da API para obter a lista de veículos.

Resposta​

A API devolverá uma resposta JSON com uma lista de veículos, incluindo detalhes como ID do veículo, modelo e outras informações relevantes.

Este exemplo básico é um ponto de partida para chamadas à Cartrack Fleet API. Pode adaptá-lo à linguagem ou ferramenta da sua preferência usando os mesmos princípios. Para mais detalhes sobre funcionalidades e endpoints adicionais, continue a explorar a documentação completa da API.

Importar para Postman​

Pode importar a especificação OpenAPI da Cartrack para o Postman e gerar uma coleção de pedidos pronta a usar.

  • URL da spec: https://developer.cartrack.com/openapi/openapi.yaml
  • No Postman: clique em Import -> Link, cole o URL e clique em Import. Em alternativa, use Import -> File e envie o ficheiro openapi.yaml descarregado.
  • O Postman criará uma coleção de pedidos com base na spec.
  • Configure os valores de ambiente:
    • Defina a base URL com base nas instruções da página Base URLs.
    • Configure a autenticação: as APIs Cartrack usam Basic Authentication. No Postman, abra qualquer pedido, vá ao separador Authorization, escolha Basic Auth e introduza o username e a password. Em alternativa, adicione o cabeçalho Authorization com o valor Basic <base64-encoded-credentials>. Consulte a página Authentication para detalhes sobre geração de credenciais.
  • Execute pedidos individualmente ou use o Collection Runner para executar várias chamadas.