Personalizando tema da página de rastreio
É possível criar temas para personalizar a página de rastreamento white-label com as cores, ícones e logotipo da marca.
- Criar novo tema
- Atualizar tema
- Consultar tema
- Excluir tema
- Exemplo – Personalizando o tema da página de rastreamento
Criar novo tema
Para criar um tema, é necessário enviar uma requisição com o método POST para o seguinte endpoint:
Um exemplo de requisição pode ser conferido abaixo:
{ "id": "Maplink", "logo": "https://example.com", "color": "#FF0000", "favicon": "https://example.com", "language": "pt_BR" }
Onde:
id
– ID para identificar o tema.logo
– URL da imagem do logotipo. Recomendável as dimensões de 40px de altura e 120px de largura.color
– Valor hexadecimal para a cor principal do site. Ex: #FF0000favicon
– URL da imagem do favicon do site. Recomendável as dimensões de 48px de altura e 48px de largura.languague
– Idioma do site. Valores possíveis: ["en", "pt", "pt_BR", "pt_PT", "es", "es_AR", "es_CL", "es_CO", "es_MX"
]
Atualizar tema
Para atualizar um tema já existente, basta enviar uma requisição com o método PUT para o seguinte endpoint:
Onde o termo {{trackingTheme}}
deve ser substituído pelo ID do tema que deseja atualizar.
Um exemplo de requisição pode ser conferido abaixo:
{ "id": "Maplink", "logo": "https://example.com", "color": "#0000CD", "favicon": "https://example.com", "language": "pt_BR" }
Consultar tema
Para consultar um tema, basta enviar uma requisição com o método GET para o seguinte endpoint:
Onde o termo {{trackingTheme}}
deve ser substituído pelo ID do tema que deseja consultar.
Excluir tema
Para excluir um tema, basta enviar uma requisição com o método DELETE para o seguinte endpoint:
Onde o termo {{trackingTheme}}
deve ser substituído pelo ID do tema que deseja excluir.
Exemplo – Personalizando o tema da página de rastreamento
No exemplo a seguir, vamos criar um tema para a página de rastreamento da empresa “Home Delivery”.
A requisição com o ícone, logo e cor do tema personalizado pode ser conferida abaixo:
{ "id": "HomeDelivery", "logo": "https://i.ibb.co/4MTKPLy/logo.png", "color": "#e8af46", "favicon": "https://i.ibb.co/Fh1qVqV/ico.png", "language": "pt_BR" }
Após isso, basta informar o nome do tema no parâmetro theme
ao criar um pedido, conforme exemplo abaixo:
{ "number": "1232132132143438", "description": "Product", "companyName": "Maplink", "status": { "value": "ON_THE_WAY", "label": "Pedido em trânsito" }, "destination": { "mainLocation": { "lat": -22.7342864, "lon": -47.6480644 } }, "driver": { "name": "Maplink BR", "currentLocation": { "lat": -23.564515, "lon": -46.652681 } }, "theme": "HomeDelivery" }
A página de rastreamento personalizada pode ser conferida na imagem abaixo: