Este guia foi criado para ajudar você a aproveitar o Tote, desde a primeira navegação até o consumo de nossas APIs. Aqui, você encontrará não apenas referências técnicas, mas também conteúdos que contextualizam, ensinam e guiam o uso das soluções oferecidas.1. Primeiros passos: conhecendo a landing page#
Figura 1. Página inicial Tote.
Destaques e atualizações recentes
Acesso direto para artigos, tutoriais e guias de integração
Acesso rápido às APIs mais utilizadas
Filtro de navegação lateral, que permite localizar conteúdos do menu lateral esquerdo do Tote
2. Learning Center: mais que documentação técnica#
Figura 2. Página inicial dos guias.
Esses conteúdos estão organizados por categoria, incluindo:Guias de primeiros passos, para quem está começando na plataforma
Manuais técnicos, com instruções detalhadas de uso
Artigos de apoio, com explicações mais conceituais ou de negócio
FAQ, com respostas para dúvidas frequentes
Glossário, com os principais termos e definições
3. Visão geral da API#
Figura 3. Diretrizes básicas das APIs.
Diretrizes básicas das APIs
Referência completa de endpoints
Exemplos de requisição e resposta
Try-it (quando aplicável)
Dica: Antes de avançar, considere verificar como autenticar, nossos requisitos e recomendações de segurança na nossa página de autenticação.
Figura 4. Página inicial da API Portadores com detalhes sobre a jornada.
4. Estrutura dos endpoints da API#
Os endpoints da API são estruturados da seguinte forma:1. Título do endpoint#
2. Path do endpoint#
Clicável para cópia. Acompanhado do botão "testar" para plataforma de testes.O protocolo HTTP de um endpoint define os métodos de requisição que serão aplicados nos dados informados no request body (item 4).| Protocolo HTTP | Funcionalidade |
|---|
| GET | Solicita dados de um recurso. |
| POST | Envia dados ao servidor para criar um recurso. |
| PUT | Cria um novo recurso ou substitui um recurso existente. |
| PATCH | Aplica solicitações parciais num recurso já existente. |
| DELETE | Remove um recurso específico. |
3. Descrição do endpoint#
Pode conter informações extras ou dicas sobre seu funcionamento.Contém informações de autorização, cabeçalhos e corpo de requisição.5. Authorization#
Cabeçalho obrigatório contendo o Bearer token disponibilizado pela empresa. Essa informação deve ser inserida manualmente no campo Auth na plataforma de testes. Para saber mais, leia nosso guia sobre como testar nossas APIs.Utilizamos headers (cabeçalhos) padrão para facilitar a integração e garantir a conformidade com as especificações técnicas.Authorization: Cabeçalho contendo o Bearer token, necessário para autenticação do cliente. O valor de exemplo já contém o Bearer disponibilizado pela empresa e é inserido automaticamente na cURL.
Accept: Tipo de conteúdo aceito pelo endpoint.
Content-Type: Presente apenas em requisições do tipo POST, define o formato do corpo da solicitação.
7. Corpo da requisição#
Pode ser dividido por processadoras, basta clicar na opção desejada para visualizar suas informações.8. Respostas#
As respostas seguem os códigos de status HTTP. Para mais detalhes, leia nosso guia de respostas e erros.9. Status code#
Status code 200 indica sucesso na requisição. Para mais detalhes sobre outros status, leia nosso guia de respostas e erros.10. cURL e outras linguagens#
Cada endpoint também possui seu cURL disponível para que seja utilizado em outras plataformas.Por padrão, os request dos endpoints são disponibilizados no formato de cURL. Porém, a plataforma também traduz automaticamente para outras linguagens, basta clicar na opção desejada. Aqui, informações traduzidas para JavaScript.Ao clicar no botão testar ao lado do caminho do endpoint (item 2 desta lista), uma pop-up se abre com uma plataforma para testes.
Materiais relacionados#
Clique no botão abaixo para nos contar o que achou da nova plataforma. Você será redirecionado para um formulário rápido. 