API e integração com o ERP
Como o DGAssistant se integra no seu ERP, no sistema de armazém ou na plataforma de expedição.
Preciso de um módulo específico para utilizar a API?
Sim, a API é um módulo licenciado à parte, que acresce às suas licenças padrão. Acrescenta-o à sua subscrição quando decidir integrar.
Como é medida e tarifada a utilização da API?
A API é medida por licença: cada uma abrange 1 500 expedições e 7 500 chamadas de serviço por ano e permite que a base de dados contenha até 5 000 objetos que não sejam expedições, tais como mercadorias e intervenientes (destinatários, fornecedores, condutores e os restantes). Se previr um volume superior, basta acrescentar mais licenças. O preço unitário exato do módulo API consta, a par do restante catálogo, na nossa loja e pode ser incluído em qualquer orçamento personalizado.
Quais são as duas formas de utilizar a API: em lote ou interativa?
O modo em lote recebe a descrição completa da expedição numa única chamada de serviço — ideal quando o ERP já conhece as mercadorias, os intervenientes e as quantidades. O modo interativo permite construir a expedição passo a passo, validando cada mercadoria à medida que é acrescentada; aproxima-se do funcionamento da aplicação web e é útil quando precisa de percursos conduzidos pelo utilizador sobre a API.
Devo criar as mercadorias e os intervenientes antecipadamente ou enviá-los no momento?
Ambas as vias são suportadas. A abordagem recomendada são os «dados predefinidos»: crie as mercadorias e os intervenientes uma vez na aplicação web (ou importe-os) e referencie-os pelo código nas chamadas à API. A abordagem no momento permite enviar tudo em cada chamada, o que é cómodo quando o seu ERP é a referência desses dados e não pretende carregá-los previamente.
Como obtenho os PDF gerados através da API?
Há duas possibilidades. Pode receber os documentos na resposta da API como PDF codificados em base64 (documento de transporte, declaração do expedidor, lista de verificação, marcação de embalagens, etc.), ou fazer com que a plataforma os envie por si própria, por correio eletrónico, para um endereço configurado.
Posso imprimir automaticamente os documentos gerados pela API?
Sim. Dois esquemas funcionam bem: (a) o seu ERP descarrega o PDF da API e envia-o para a sua própria fila de impressão; (b) o DGAssistant envia os documentos para uma caixa de correio dedicada e um pequeno utilitário de impressão automática, do seu lado, imprime-os na impressora correta. Muitos clientes escolhem a via do correio eletrónico por não exigir código adicional do lado do ERP.
Onde está a especificação da API?
A especificação OpenAPI completa, com exemplos interativos, está publicada na documentação da API de mercadorias perigosas. Disponibilizamos ainda um projeto SoapUI com chamadas de teste realistas, para que os seus programadores a possam explorar em poucos minutos.
O que é o requestGuid e porque é exigido?
Cada chamada à API tem de conter um requestGuid único que identifica o pedido nos nossos registos e permite à nossa equipa de suporte localizar a transação exata quando comunica uma ocorrência. É aceite qualquer valor alfanumérico único; recomendamos gerar um UUID/GUID normalizado do lado do cliente.
Qual é o motivo mais frequente para uma chamada à API falhar à primeira tentativa?
Credenciais que o serviço não aceita: um cabeçalho HTTP Basic Authorization em falta ou incorreto ou, quando a chamada é autenticada com OAuth2, um token de acesso que nunca foi pedido, que pertence a outro ambiente ou que já caducou. Existe um endereço de suporte dedicado que pode invocar para confirmar que a API responde e que as suas credenciais são válidas. Se ficar bloqueado, envie-nos o pedido e a resposta HTTP completos (incluindo o requestGuid) e uma descrição do comportamento esperado — é isso que desbloqueia a situação mais depressa.