API REST de mercadorias perigosas

O que a API faz

Remessas. A API REST JSON do DGAssistant cria a remessa de mercadorias perigosas a partir do seu sistema de gestão ou de logística e devolve a declaração do expedidor, a lista de verificações e a marcação dos volumes, já verificadas face à regulamentação aplicável. O seu sistema guarda os dados comerciais; o DGAssistant fornece o conhecimento regulamentar e os documentos.

Consolidação. A API abrange também o agrupamento de remessas de vários expedidores, ao longo dos seus dois eixos. O eixo contratual é a expedição principal — uma reserva, uma consolidação marítima ou aérea, uma grupagem rodoviária — com os seus intervenientes, as suas referências, as remessas que lhe estão associadas, as suas mudanças de estado e o seu histórico. O eixo físico é a unidade de transporte (contentor, veículo, reboque ou unidade de carga) e o movimento de transporte (viagem, voo ou trajeto) com as suas escalas, juntamente com os navios, veículos e locais da conta. Mais de metade do serviço é dedicada a esta parte.

Abrir a especificação da API de mercadorias perigosas

Duas formas de trabalhar: em lote e interativa

Em lote. Uma única chamada leva a especificação completa da remessa com todas as suas mercadorias. É a via destinada aos sistemas de gestão e de logística que enviam remessas já compostas.

Interativa. Primeiro abre-se a remessa e depois acrescentam-se as mercadorias uma a uma. Cada resposta traz as mensagens de validação do que acabou de ser acrescentado, para que a sua aplicação as possa mostrar ao utilizador enquanto a remessa é preparada.

Dados predefinidos ou dados na própria chamada

Dados predefinidos. Os produtos e os intervenientes — expedidores, transportadores, destinatários, carregadores e condutores — são criados previamente e a API utiliza os seus códigos. É a forma mais simples de trabalhar e a que recomendamos, porque a classificação regulamentar se resolve uma vez e se reutiliza em cada remessa.

Dados na própria chamada. Os produtos e os intervenientes definem-se na mesma chamada que cria a remessa. Adequa-se a sistemas que não mantêm catálogo próprio ou que expedem mercadorias ocasionais.

Os documentos que devolve

A API devolve os mesmos documentos que a aplicação produz. Os da remessa e os da consolidação obtêm-se em PDF, XLSX ou DOCX, os da remessa podem ainda ser enviados por correio eletrónico a partir do próprio serviço; os da declaração de expedição, em PDF.

• Para cada remessa: o documento de transporte da regulamentação aplicável —o documento de transporte ADR, a declaração de mercadorias perigosas IMO ou o formulário multimodal IMDG e a declaração do expedidor IATA—, a lista de verificações, a marcação dos volumes em tamanho completo ou em tamanho pequeno personalizado e, por via aérea, a ficha de dados para a carta de porte aéreo.
• Para a expedição principal: o manifesto de consolidação, a lista de contentores, a lista de volumes de cada unidade, a folha de carga por expedidor e a ficha de dados do documento principal.
• Para a unidade de transporte: o certificado de acondicionamento do contentor ou do veículo, o formulário multimodal de mercadorias perigosas, o relatório de segregação da unidade, a lista de verificações prévia à assinatura do certificado e a etiqueta de consolidação.
• Para a viagem: o manifesto de mercadorias perigosas, o relatório de segregação entre unidades a bordo, o relatório do limiar de isenção do ADR 1.1.3.6, a ficha de restrições da viagem, a folha de carga, a notificação ao comandante (NOTOC) e o documento de transporte consolidado do veículo.
• Para a declaração de expedição: o rascunho, a cópia assinada, o documento de transporte ADR anexo e o relatório de evidências.

O que a API verifica

Na remessa. A segregação entre as mercadorias transportadas em conjunto, os limites de quantidade da instrução de embalagem aplicável e dos regimes de quantidade limitada e excetuada, a admissibilidade das mercadorias para o modo de transporte, a legalidade da embalagem e a completude da declaração. Quando algo não cumpre, a resposta indica que regra não é satisfeita e com que valores, para que a mensagem possa ser mostrada na sua aplicação.

Na consolidação. A segregação dentro da unidade de transporte, a segregação entre as unidades carregadas no mesmo movimento, o cálculo do limiar 1.1.3.6 do ADR para o movimento com a respetiva decomposição, e as restrições do trajeto devolvidas como dados, tais como o código de restrição em túneis ou a presença de mercadorias perigosas de alto risco.

Regulamentações e tipos de transporte abrangidos

ADR para a estrada, IMDG para o mar, IATA para o ar e 49 CFR. As três regulamentações principais são geridas em conjunto e não como módulos separados, de modo que uma remessa que muda de modo de transporte não tenha de ser preparada de novo.

Embalagem em comum, sobrembalagens, cisternas, transporte a granel, embalagens vazias por limpar, resíduos, explosivos da classe 1 —com a sua massa líquida de matéria explosiva por volume— e matérias radioativas da classe 7 são suportados, com os dados que cada um exige. Os textos dos documentos são emitidos em dezanove idiomas.

Disponibilidade

O serviço é publicado em três regiões — Europa, Américas e Ásia-Pacífico —, cada uma com o seu próprio endereço, para que a integração funcione com a região onde a conta está alojada. A infraestrutura é redundante e vigiada permanentemente.

Como começar

Solicite um teste gratuito de duas semanas e, com ele, as credenciais do serviço. A autenticação usa OAuth 2.0 com o método «client credentials»: o seu sistema obtém um token de acesso e envia-o em cada pedido.

A especificação completa está publicada em formato OpenAPI e pode ser lida, explorada e utilizada para gerar um cliente na sua própria linguagem antes de escrever uma única linha de código de integração.