Crie etiquetas para encomendas com o FileMaker e o DHL API
A ligação do FileMaker ao DHL REST API permite a criação automática de etiquetas de encomendas para envio. Neste guia passo-a-passo, aprenderá a programar a FileMaker de modo a que a sua solução FileMaker comunique com a DHL REST API para solicitar e descarregar etiquetas de encomendas.
A API da DHL pode ser usada para automatizar uma ampla gama de processos de envio e rastreamento. Para além de criar etiquetas de encomendas (etiquetas de envio), os utilizadores podem também automatizar o seguimento para monitorizar o estado das suas encomendas em tempo real. A API também permite a criação de etiquetas de devolução para simplificar as devoluções para os clientes. Além disso, podem ser criados diretamente e integrados no processo de expedição documentos de expedição importantes, tais como declarações aduaneiras para expedições internacionais. Para além disso, os envios podem ser priorizados ou podem ser adicionadas determinadas opções de envio, tais como pagamento contra entrega ou seguro. A API da DHL oferece assim uma solução abrangente para otimizar todo o processo de envio e integrá-lo totalmente em sistemas existentes, como o FileMaker. Neste guia, vamos mostrar-lhe como criar etiquetas de encomendas com a API.
Quatro plataformas FileMaker ERP com CRM e gestão de mercadorias para processos operacionais optimizados.
Pedir informações
Pré-requisitos
- Uma conta de cliente empresarial da DHL com acesso à API de cliente empresarial da DHL.
- Os dados de acesso à API REST da DHL, ou seja, a chave da API, o nome de utilizador e a palavra-passe.
- FileMaker Pro versão 16 ou superior, uma vez que estas versões suportam nativamente os pedidos HTTP necessários.
1. configurar a conta de cliente empresarial da DHL e o acesso à API
Antes de poder integrar a API da DHL no FileMaker, é necessário ter acesso à API da DHL:
- Vá para a página do Portal do Desenvolvedor DHL: Portal do Desenvolvedor DHL.
- Registe-se com a sua conta de cliente empresarial.
- Solicitar os dados de acesso à API (chave da API, nome de utilizador, palavra-passe).
- Verifique o seu acesso e active o serviço "DHL Shipping API".
2. Primeiros passos com a API da DHL
A API da DHL utiliza pedidos HTTP para enviar e receber dados. As funções mais importantes para criar uma etiqueta de encomenda são
- AutenticaçãoAutenticação básica com nome de utilizador e palavra-passe.
- Criar uma etiqueta (etiqueta de encomenda)Envie os dados de expedição e receba a etiqueta em formato PDF.
- Recuperar a etiquetaO retorno está em formato PDF binário, que pode ser guardado e utilizado num campo de contentor na FileMaker.
3. scripts FileMaker para aceder ao DHL API
O FileMaker usa o comando Inserir a partir do URL em combinação com opções cURL para enviar pedidos HTTP para a API e receber respostas.
3.1 Preparar a autenticação
A DHL utiliza autenticação básica. Na FileMaker, isto é conseguido fornecendo o nome de utilizador e a palavra-passe no formato Base64. Abaixo encontrará um exemplo de como pode preparar a autenticação:
Base64Encode("Nome de utilizador:Palavra-passe")
No FileMaker, pode introduzir esta cadeia diretamente no Inserir a partir do URL-comando com as opções cURL correspondentes.
3.2 Criar notas de envio
A API requer determinadas informações, como o endereço do remetente, o endereço do destinatário, o peso, o método de envio, etc. Segue-se um exemplo simples de um pedido à API da DHL para criar uma etiqueta.
Script: Criar etiqueta de encomenda
- Abra a janela do espaço de trabalho do script no FileMaker.
- Criar um novo guião, por exemplo, "Criar etiqueta de encomenda".
- Adicione as seguintes variáveis para guardar os dados de expedição:
Definir variável [ $url; valor: "https://cig.dhl.de/services/production/rest/sendungsverfolgung/v2/paketmarken" ]
Definir variável [ $auth; Valor: "Base64Encode(username:password)" ]
Definir variável [ $payload; Valor: "{ 'Version': '2.0', 'shipmentDetails': {...} }" ]
# Introduzir aqui os dados de expedição em formato JSON
Exemplo do pedido JSON (payload) que envia à DHL:
{
"Versão": "2.0",
"ShipmentOrder": [
{
"sequenceNumber": "1",
"Expedição": {
"Expedidor": {
"Nome": "A sua empresa",
"Endereço": {
"StreetName": "Rua",
"BuildingNumber": "1",
"PostalCode": "12345",
"Cidade": "cidade",
"CountryCode": "DE"
}
},
"Recetor": {
"nome": "destinatário",
"Endereço": {
"StreetName": "Rua do destinatário",
"BuildingNumber": "10",
"PostalCode": "54321",
"Cidade": "cidade destinatária",
"CountryCode": "DE"
}
},
"ShipmentDetails": {
"ProductCode": "V01PAK", # Método de envio (por exemplo, encomenda nacional)
"WeightInKG": "2.5", # Peso da embalagem
"CustomerReference": "123456", Número de referência do #
"ShipmentDate": "2023-09-01"
}
},
"LabelResponseType": "URL"
}
]
}
Utilizar o Inserir a partir do URL-comando para enviar o pedido à DHL e criar a etiqueta:
Inserir a partir de URL [ Seleção ; Target: $response ; URL: $url ; Opções cURL:
"-X POST --header \"Autorização: Básica" & $auth & "\"" &
"--header \"Content-Type: application/json\"" &
"--data " & $payload ]
3.3 Descarregar e guardar a etiqueta
A etiqueta criada é devolvida pela API na forma de um ficheiro PDF. Pode guardá-lo num campo de contentor FileMaker.
- Insira um campo de contentor na sua base de dados FileMaker para guardar o ficheiro PDF.
- Altere o seu script para que o ficheiro PDF seja transferido para este campo de contentor:
Inserir a partir de URL [ Seleção ; Destino: Campo Table::Container ; URL: "response-PDF-URL" ]
O campo response-PDF-URL é devolvido pela API da DHL após a etiqueta ter sido criada com sucesso e contém o URL onde o PDF pode ser descarregado.
Curso rápido de FileMaker
FileMaker rápido e eficaz
aprendizagem em 20 capítulos.
Participar gratuitamente
4. criar uma carga útil JSON com a FileMaker
Abaixo está um script da FileMaker que mostra como pode construir o payload JSON com dados dos campos da FileMaker. Neste exemplo, assumimos que os campos na sua base de dados FileMaker contêm informações sobre o remetente, destinatário e detalhes de envio e chamamos à sua tabela "Tabela" com os nomes de campo correspondentes, que deve adaptar em conformidade na sua solução FileMaker. A estrutura JSON corresponde àquela que pode enviar para a API da DHL.
Exemplo de script em FileMaker:
# Definir variáveis para a estrutura JSON
Definir variável [ $jsonSender; Valor: JSONSetElement ( "{}" ;
[ "Name" ; Table::SenderCompany ; JSONString ] ;
[ "Address.StreetName" ; Table::SenderStreet ; JSONString ] ;
[ "Address.BuildingNumber" ; Table::SenderHouseNumber ; JSONString ] ;
[ "Address.PostalCode" ; Table::SenderPLZ ; JSONString ] ;
[ "Address.City" ; Table::SenderCity ; JSONString ] ;
[ "Address.CountryCode" ; Table::SenderCountry ; JSONString ]
)]
Definir variável [ $jsonReceiver; Valor: JSONSetElement ( "{}" ;
[ "Name" ; Table::RecipientName ; JSONString ] ;
[ "Address.StreetName" ; Table::RecipientStreet ; JSONString ] ;
[ "Address.BuildingNumber" ; Table::RecipientHouseNumber ; JSONString ] ;
[ "Address.PostalCode" ; Table::RecipientPLZ ; JSONString ] ;
[ "Address.City" ; Table::RecipientCity ; JSONString ] ;
[ "Address.CountryCode" ; Table::RecipientCountry ; JSONString ]
)]
Definir variável [ $jsonShippingDetails; Valor: JSONSetElement ( "{}" ;
[ "ProductCode" ; Table::ProductCode ; JSONString ] ;
[ "WeightInKG" ; Table::Shipping weight ; JSONNumber ] ;
[ "CustomerReference" ; Table::ReferenceNumber ; JSONString ] ;
[ "ShipmentDate" ; Table::ShipmentDate ; JSONString ]
)]
# Estrutura de todo o documento JSON
Definir variável [ $payload; Valor: JSONSetElement ( "{}" ;
[ "Versão" ; "2.0" ; JSONString ] ;
[ "ShipmentOrder[0].sequenceNumber" ; "1" ; JSONString ] ;
[ "ShipmentOrder[0].Shipment.Shipper" ; $jsonSender ; JSONObject ] ;
[ "ShipmentOrder[0].Shipment.Receiver" ; $jsonEmpfänger ; JSONObject ] ;
[ "ShipmentOrder[0].Shipment.ShipmentDetails" ; $jsonVersanddetails ; JSONObject ] ;
[ "ShipmentOrder[0].LabelResponseType" ; "URL" ; JSONString ]
)]
O payload JSON gerado é guardado na variável $payload que pode utilizar como a definição da variável $payload no script Create package label acima.
ERP FileMaker personalizável com interfaces de gestão de mercadorias e logística.
Mais informações Perguntas frequentes sobre a FileMaker e a DHL API
- O que é a interface DHL e como pode ser integrada com a FileMaker?
- A interface DHL permite o envio automatizado de dados de encomendas para a DHL e a recuperação de etiquetas de encomendas e dados de rastreio de envios. No FileMaker, pode utilizar esta interface para automatizar processos de envio e gerar etiquetas de encomendas diretamente a partir da sua base de dados.
- Quais são as vantagens de integrar a interface DHL no FileMaker?
- A integração permite-lhe poupar tempo e evitar erros, uma vez que os dados de envio são transferidos diretamente da base de dados FileMaker para a DHL. Pode também gerar etiquetas de encomendas automaticamente e integrar o seguimento de envios no seu sistema, o que aumenta a eficiência no processo de envio.
- De que informações necessito para utilizar o interface DHL na FileMaker?
- São necessários dados de acesso à API da DHL (número de cliente, nome de utilizador, palavra-passe), bem como os endpoints da API da DHL. Esta informação é fornecida pela DHL após o registo para acesso à interface.
- Como é que posso gerar etiquetas de encomendas através da interface DHL na FileMaker?
- Depois de ter introduzido os dados de envio, tais como endereço do destinatário, peso e método de envio no FileMaker, pode enviar esta informação para a interface DHL através de um script API. Em troca, recebe um número de encomenda e uma etiqueta para impressão que pode ser guardada na FileMaker ou impressa diretamente.
- Posso integrar o seguimento de envios na FileMaker?
- Sim, com a interface DHL pode obter o número de localização e guardá-lo no FileMaker. Pode utilizar a API para consultar o estado atual de uma encomenda em tempo real e apresentar esta informação diretamente na sua base de dados.
- A interface da DHL na FileMaker só é adequada para envios nacionais?
- Não, a interface DHL suporta envios nacionais e internacionais. Dependendo do destino e do tipo de envio, é possível transferir vários parâmetros para o API da DHL na FileMaker, de modo a gerar etiquetas e informações de envio para diferentes países.
- Quão seguro é o uso do DHL API com o FileMaker?
- A comunicação com a API da DHL é efectuada através de HTTPS, o que garante uma transmissão de dados segura. Na FileMaker, deve garantir que os dados sensíveis, tais como os dados de acesso à API e as informações dos clientes, são armazenados e protegidos em campos encriptados.
- Posso criar processos automatizados para a interface DHL na FileMaker?
- Sim, pode criar scripts no FileMaker que enviam automaticamente dados de envio para a DHL, recuperam etiquetas de encomendas e actualizam regularmente o seguimento de envios. Estes processos também podem ser executados numa base programada para permitir a automatização total do processo de envio.
- Que requisitos tem a DHL para a integração da interface na FileMaker?
- A DHL exige que a API seja implementada corretamente, incluindo a conformidade com as especificações da API descritas na documentação da API da DHL. Você também deve garantir que sua aplicação seja liberada para uso produtivo após a DHL ter verificado a implementação.
- O que devo fazer se ocorrer um problema ao usar a interface DHL no FileMaker?
- Se ocorrerem problemas ao comunicar com o API da DHL, deve primeiro verificar as respostas aos pedidos do API na FileMaker. Os códigos de erro e as mensagens da DHL geralmente fornecem informações detalhadas sobre o problema. Se as dificuldades persistirem, pode consultar o apoio da DHL ou a documentação técnica da API para resolver o problema.
Resumo
Ao ligar o FileMaker ao DHL REST API, pode automatizar eficazmente a criação de etiquetas de encomendas. Os passos mais importantes estão resumidos abaixo:
- Solicitar e configurar dados de acesso à API.
- Criar scripts na FileMaker para enviar dados de envio para a DHL.
- Receber e guardar etiquetas em PDF.
- Integrar o tratamento de erros para monitorizar as respostas da API.
Esta configuração permite-lhe integrar totalmente o processo de envio na FileMaker e criar etiquetas de encomendas diretamente a partir da sua base de dados.
