O último artigo da nossa série sobre a API EasyCargo fornece um guia completo, passo a passo, sobre o planeamento de cargas por meio do API. Iremos acompanhá-lo ao longo de todo o processo, desde a configuração inicial até à obtenção dos relatórios do plano de carga, com demonstração do uso do API e de como funciona no EasyCargo. Este guia baseia-se em conceitos fundamentais, enquanto introduz funcionalidades avançadas para otimizar as operações de planeamento do transporte de carga.

Antes de analisar os pormenores da implementação, construa uma base sólida com os dois materiais essenciais a seguir Guia teórico API trata de todos os fundamentos que precisa de saber sobre APIs, enquanto o nosso Guia prático para solicitações e testes de API com ReqBin orienta-o na configuração do API, bem como testá-lo. Em conjunto, estes artigos estabelecem as bases essenciais e fornecem um contexto crucial para os tópicos que serão abordados neste artigo.

Processo de planeamento de carga passo a passo

Para utilizar os seguintes pedidos de API, terá de incluir um token de autenticação no cabeçalho do pedido. Pode encontrar procedimentos de autenticação detalhados no nosso artigo anterior. Para obter um token de autenticação, é necessário ter uma chave API associada à sua conta de utilizador. Contactar a nossa equipa de apoio para solicitar uma chave de API. Lembre-se de que os tokens de autenticação são válidos apenas por 1,5 horas e expiram depois disso por motivos de segurança.

Configurar o acesso do utilizador

A primeira e uma das mais importantes etapas do nosso processo de planeamento da carga é a criação de uma conta, por exemplo, para o pessoal do armazém. Utilizar a conta /api/v1/users endpoint, pode criar contas para utilizador com permissões específicas. É necessário fornecer determinados dados do utilizador, como mostra o pedido API abaixo. O painel EasyCargo reflete imediatamente esta inclusão, que confirma o acesso do utilizador à conta da empresa. Este processo simplificado garante adequadamente a gestão do acesso e os controlos de segurança para as suas operações de planeamento de carga, enquanto mantém a eficiência operacional.

No trecho de código abaixo, enviaremos um pedido para o /api/v1/users endpoint com um código que contém detalhes sobre um utilizador para o qual queremos criar uma conta. Queremos especificar um nome próprio, apelido, endereço de correio eletrónico para iniciar sessão e uma função de utilizador. A função do utilizador pode ser um administrador (representado por um 1 no corpo do pedido) ou um utilizador normal (representado por um 2).

Ver o modelo completo do pedido de API: https://reqbin.com/duacb1ye

Definição dos espaços de carga

Antes de iniciar qualquer operação de planeamento da carga, é essencial definir os espaços de carga. Os /api/v1/cargospaces endpoint permite especificar as dimensões do contentor onde os itens serão colocados. Cada definição de espaço de carga requer especificações importantes, como comprimento, largura, altura e capacidade máxima de carga. Atualmente, a API apenas suporta espaços de carga do tipo contentor para criação pelo utilizador, com a possibilidade de suportar outros tipos de espaços de carga em futuras actualizações. O sistema valida todas as especificações para garantir que cumprem os requisitos operacionais e as normas de segurança. Uma vez definido, o espaço de carga aparece na interface EasyCargo, o que confirma uma criação bem-sucedida e permite a utilização imediata para o planeamento da carga.

No trecho de código abaixo, enviaremos um pedido ao /api/v1/cargospaces endpoint com um corpo que contém detalhes sobre o contentor, com o objetivo de criar um espaço de carga. Especificamos o nome, a largura, a altura, o comprimento e o peso máximo de carga. Também indicamos o sistema de medição utilizado para definir os valores (1 para o sistema métrico e 2 para o sistema imperial) e o tipo de espaço de carga, que é definido como 1, o que representa um contentor. Como referido anteriormente, apenas este tipo de espaço de carga é suportado.

Ver o modelo completo do pedido de API: https://reqbin.com/8ieqp8ey

Gestão de itens a serem carregados

Com os espaços de carga definidos, o próximo passo é criar um espaço de carga através do /api/v1/shipment-inputs endpoint. Este processo envolve a especificação dos pormenores da expedição e dos artigos individuais a carregar. Cada item requer atributos abrangentes, ao incluir dimensões precisas, especificações de peso, requisitos de manuseamento e restrições de empilhamento. A interface EasyCargo fornece uma confirmação visual da criação bem-sucedida do transporte, o que exibi todos os itens e suas especificações. Esta entrada detalhada garante um planeamento preciso da carga e uma utilização ótima do espaço nas etapas subsequentes, o que mantem a conformidade com os regulamentos de segurança e os protocolos de manuseamento.

No trecho de código abaixo, criaremos um novo carregamento com 82 peças de um tipo de item através do comando /api/v1/shipment-inputs endpoint. No corpo do código, especificaremos o nome da remessa, o sistema de medição e os itens armazenados. Para os artigos, podemos especificar os seus detalhes, como medidas e restrições de embalagem. Neste exemplo, manteremos as mercadorias num grupo prioritário chamado Berlim, uma vez que é aqui que queremos entregar frigoríficos. Permitiremos que sejam giratórios e empilháveis quando os embalarmos no espaço de carga. Tenha em atenção que atualmente não é possível escolha a cor ou controlar se a etiqueta do item é apresentada ou não através do API.

Ver o modelo completo do pedido de API: https://reqbin.com/ozixloob

Processo de otimização do plano de carga

Uma vez estabelecidos os detalhes do envio, o motor de otimização do EasyCargo assume o controlo para gerar planos de carregamento eficientes. Embora o processo de otimização diretamente através da API esteja atualmente em desenvolvimento, os utilizadores podem aceder a esta funcionalidade através da interface do EasyCargo, ao clicar no botão Carregar. O EasyCargo considera vários fatores, como a distribuição de peso, a sequência de carregamento e os requisitos de entrega para criar arranjos ideais. Após a otimização inicial, os utilizadores mantêm a flexibilidade de fazer ajustes manuais ou modificar as seleções do espaço de carga, o que garante que o plano final satisfaça os requisitos e restrições operacionais específicos, enquanto maximiza a eficiência.

Geração de relatórios de planos de carga

Após a finalização do plano de carregamento, a documentação completa fica disponível através do /api/v1/shipment-reports/{id} endpoint. Estes dados detalhados relatórios de planos de carga incluem disposições de carga, visualizações 3D e instruções de carga precisas. Cada relatório fornece métricas críticas, como a utilização do espaço, dados de distribuição de peso e diretrizes de manuseamento específicas para o pessoal de carregamento. O sistema gera modelos 3D interativos e instruções em PDF que podem ser descarregadas, o que garante a acessibilidade de todas as partes interessadas, como os funcionários do armazém e os seus clientes. Estes relatórios servem como referências essenciais durante o processo de carregamento físico, o que ajuda a manter a coerência entre o que foi planejado e carregado. Para mais informações, consulte o relatório de expedição.

No trecho de código abaixo, vamos recuperar todos os detalhes do relatório de carregamento através da função /api/v1/shipment-report/{id} endpoint. Primeiro, precisamos de obter o ID do relatório de expedição ao enviar um pedido GET para /api/v1/shipments. Retire o ID do relatório de expedição desta resposta e inclua-o no caminho URL do seu próximo pedido (/api/v1/shipment-report/{id}). A resposta conterá todos os detalhes que vê na imagem abaixo no relatório PDF imprimível.

Ver o modelo completo do pedido de API: https://reqbin.com/ust8mrq2

Partilhar e colaborar

A fase final consiste em distribuir a informação do plano de carregamento às partes interessadas relevantes através do /api/v1/shipments endpoint. Esta funcionalidade permite o acesso a detalhes abrangentes do carregamento e a relatórios associados, ao incluir representações 3D interativas do plano de carregamento. Os intervenientes podem aceder ao plano através de um URL público, o que permite a visualização e verificação em tempo real da disposição do carregamento. Esta abordagem colaborativa garante que todos os participantes no processo de carregamento têm acesso imediato às informações necessárias, o que facilita a coordenação eficiente e a implementação exata do plano de carregamento. É possível aceder ao URL público do plano de carregamento no EasyCargo para ver a disposição das mercadorias.

No trecho de código abaixo, vamos recuperar todos os detalhes da nossa remessa criada anteriormente por meio do comando /api/v1/shipments/{id} endpoint. Para obter a ID do envio, comece por enviar um pedido GET para /api/v1/shipments. Depois de identificar o seu ID de carregamento, faça um pedido GET para /api/v1/shipments/{id} para receber informações completas sobre o envio, tais como o link público, link do relatório de carregamento e outras informações apresentadas abaixo.

Ver o modelo completo do pedido do API: https://reqbin.com/y5p3zysj

Em conclusão, o impacto dos API no setor do TI não pode ser subestimado, pois tornaram-se elementos fundamentais da arquitetura moderna do software e das operações comerciais. A API EasyCargo é um exemplo de como interfaces bem concebidas podem simplificar operações logísticas complexas, enquanto mantêm a precisão e a eficiência. Esperamos que esta série abrangente tenha fornecido informações valiosas sobre a utilização da API EasyCargo para as suas necessidades logísticas. Quer seja um novato em APIs ou um programador experiente, as possibilidades de integração são extensas. Para uma consulta personalizada sobre a implementação do EasyCargo nas suas operações, contacte-nos através do nosso formulário de contacto. A nossa equipa está pronta para o ajudar a explorar a nossa solução para responder às suas necessidades específicas.