Guia Rápido

Este guia traça os primeiros passos para você ter sucesso, do seu "Oi!" inicial à sua primeira rota consultada, tudo em menos de 10 minutos.

1. Acessando o Ambiente de Testes

Antes de mais nada, precisamos habilitar o seu acesso ao nosso ambiente de testes (Staging).

https://platform-bff-partners.stg.clickbus.net/partners/api/

2. Realizando a Autenticação

Nossa plataforma usa o padrão OAuth 2.0. Você precisa de um token de acesso para todas as requisições protegidas a fim de garantir a segurança nas transações via API.

Como Funciona

O fluxo de autenticação inicial para parceiros é via POST no endpoint:

{URL Base}/oauth/basic-token

A Missão: Utilize suas credenciais (usuário e senha) fornecidas pelo time Comercial no Authorization Header para obter seu accessToken e refreshToken.

Exemplo de Requisição

curl --location 'platform-bff-partners.stg.clickbus.net/partners/api/oauth/basic-token' \
--header 'Content-Type: application/json' \
--header 'Authorization: preencher aqui a senha do seu usuário. Ex.: $2a[...]a' \
--data '{
    "grant_type": "client_credentials"
}'

3. Consultando Disponibilidade de Viagens

Com o seu accessToken em mãos (lembre-se de usá-lo no Authorization Header da próxima requisição), você está pronto para sua primeira consulta de rota, usando o endpoint /v5/trips.

A Missão: Consulte a rota Rio de Janeiro para Belo Horizonte, especificando a origem (from) e destino (to) via slug.

Exemplo de Requisição

curl --location 'https://platform-bff-partners.stg.clickbus.net/partners/api/v5/trips?from=rio-de-janeiro-rj-todos&to=belo-horizonte-mg-todos' \
--header 'Authorization: Bearer {seu_access_token}'

4. Entendendo o Retorno

Se sua busca foi bem-sucedida, o retorno será um JSON contendo uma lista de partidas (departures), incluindo informações como:

🎉 Próximos Passos

✅ Parabéns! Você completou sua primeira chamada à API ClickBus. Com este fluxo básico, você já está conectado e pronto para explorar todas as funcionalidades da nossa plataforma.