Introdução

O objetivo deste documento é descrever a interface das APIs de integração da Plataforma Bikes Cycle.

Autenticação

As API’s listadas nessa documentação utilizam autenticação OAuth2, isso significa que em todas as requisições é necessário informar um token de acesso que será obtido através da autenticação com o seu Client ID e Client Secret.

Processo de Homologação

Para iniciar a homologação de sua integração com a nossa Plataforma, utilizando nosso ambiente de testes você precisa ser credenciado.

Caso já seja cliente nosso, entre em contato para que possa solicitar a habilitação do produto para você.

Geração do token de acesso

Endpoint responsável pela geração do token de acesso utilizado nas demais requisições, para isso utilizamos HTTP Basic Authentication.

PARAMETERS
FormData Parameters
scope
string Required Default: "oob" Usar o valor fixo "oob"
grant_type
string Required Default: "client_credentials" Usar O valor fixo "client_credentials"
Header Parameters
Content-Type
string Required Default: "application/x-www-form-urlencoded" Tipo do conteúdo.
Authorization
string Required Authorization: Basic AuthString Onde AuthString é a concatenação do seu Client ID, seguido de ":" (dois pontos) mais seu Client Secret, convertidos para base64. Como exemplo: Para o Client ID igual a client-01 e Client Secret igual a secret-key-02, teremos o texto client-01:secret-key-02 após a concatenação, convertendo para base64 teremos o resultado Y2xpZW50LTAxOnNlY3JldC1rZXktMDI=
Responses
200 - Sucesso
access_token
string -uuidv4- 36 characters Token de acesso a API para envio em todas as requisições.
token_type
string Tipo do token, deve ser enviado no header junto do token.
expires_in
number Tempo de expiração do token em segundos.
400 - Requisição Inválida
401 - Credenciais Inválidas
500 - Erro interno do servidor ou serviço indisponível

Criar uma entrega

Neste endpoint você pode criar uma nova entrega.

PARAMETERS
Request Body
tpAlocacao
number Required Usar o valor 0 = entrega normal | 1 = entrega alocada | 2 = entrega alfa
cliente
object Dados do cliente envolido na entrega
nome
string <= 120 Nome do cliente
email
string E-mail do cliente
cpf
string <= 14 Cpf do cliente. (sem máscara)
rg
string <= 11 RG do cliente. (sem máscara)
celular
string <= 15 Celular do cliente. (sem máscara)
telefone
string <= 14 Telefone do cliente. (sem máscara)
cep
string <= 8 Código Postal, CEP no Brasil. (sem máscara)
logradouro
string <= 60 Logradouro.
numero
string <= 10 Número do logradouro.
complemento
string <= 60 Complemento do logradouro.
bairro
string <= 40 Bairro.
cidade
string <= 40 Cidade.
estado
string <= 2 Estado (UF).
coleta
object Dados de coleta da entrega.
nome
string <= 120 Nome do cliente para coleta
cep
string <= 8 Código Postal, CEP no Brasil. (sem máscara)
logradouro
string <= 60 Logradouro.
numero
string <= 10 Número do logradouro.
complemento
string <= 60 Complemento do logradouro.
bairro
string <= 40 Bairro.
cidade
string <= 40 Cidade.
estado
string <= 2 Estado (UF).
Header Parameters
Content-Type
string Required Default: "application/json; charset=utf-8" Tipo do conteúdo.
Authorization
string Required Authorization: Bearer AuthString Onde AuthString é token de acesso obtido no endpoint de autenticação.
Responses
201 - Entrega criada com sucesso
entregaId
number >= 1 Número gerado da entrega.
inicio
string <YYYY-MM-DD HH:mm> Data início da entrega
400 - Requisição Inválida
401 - Credenciais Inválidas
500 - Erro interno do servidor ou serviço indisponível

Saiu para entrega

Neste endpoint você pode sinaliza que a entrega está em trânsito.

PARAMETERS
Query Parameter
entregaId
number >= 1 Required Número da entrega
Header Parameters
Content-Type
string Required Default: "application/json; charset=utf-8" Tipo do conteúdo.
Authorization
string Required Authorization: Bearer AuthString Onde AuthString é token de acesso obtido no endpoint de autenticação.
Responses
200 - Entrega em trânsito
entregaId
number >= 1 Número gerado da entrega
400 - Requisição Inválida
401 - Credenciais Inválidas
500 - Erro interno do servidor ou serviço indisponível

Finalizando uma entrega

Neste endpoint você pode finalizar uma entrega.

PARAMETERS
Query Parameter
entregaId
number >= 1 Required Número da entrega
Header Parameters
Content-Type
string Required Default: "application/json; charset=utf-8" Tipo do conteúdo.
Authorization
string Required Authorization: Bearer AuthString Onde AuthString é token de acesso obtido no endpoint de autenticação.
Responses
200 - Entrega finalizada com sucesso
entregaId
number >= 1 Número gerado da entrega
400 - Requisição Inválida
401 - Credenciais Inválidas
500 - Erro interno do servidor ou serviço indisponível

Cancelando uma entrega

Neste endpoint você pode cancelar uma entrega.

PARAMETERS
Query Parameter
entregaId
number >= 1 Required Número da entrega
Header Parameters
Content-Type
string Required Default: "application/json; charset=utf-8" Tipo do conteúdo.
Authorization
string Required Authorization: Bearer AuthString Onde AuthString é token de acesso obtido no endpoint de autenticação.
Responses
200 - Entrega cancelada com sucesso
entregaId
number >= 1 Número gerado da entrega
400 - Requisição Inválida
401 - Credenciais Inválidas
500 - Erro interno do servidor ou serviço indisponível

Dados do Entregador

Neste endpoint você é possível verificar os dados do entregador que aceitou a entrega.

PARAMETERS
Query Parameter
entregaId
number >= 1 Required Número da entrega
Header Parameters
Content-Type
string Required Default: "application/json; charset=utf-8" Tipo do conteúdo.
Authorization
string Required Authorization: Bearer AuthString Onde AuthString é token de acesso obtido no endpoint de autenticação.
Responses
200 - Sucesso
nome
string Nome do entregador
imagem
string Url da imagem do entregador
400 - Requisição Inválida
401 - Credenciais Inválidas
500 - Erro interno do servidor ou serviço indisponível

Quantidade de entregadores disponíveis

Neste endpoint você pode verificar a quantidade de entregadores disponíveis para uma empresa.

PARAMETERS
Header Parameters
Content-Type
string Required Default: "application/json; charset=utf-8" Tipo do conteúdo.
Authorization
string Required Authorization: Bearer AuthString Onde AuthString é token de acesso obtido no endpoint de autenticação.
Responses
200 - Sucesso
qtd
number >= 1 Número de quantidade de entregadores disponíveis
400 - Requisição Inválida
401 - Credenciais Inválidas
500 - Erro interno do servidor ou serviço indisponível