API e integración con el ERP
Cómo encaja DGAssistant en su ERP, su sistema de almacén o su plataforma de expediciones.
¿Necesito un módulo especial para usar la API?
Sí, la API es un módulo con licencia propia que se añade a las licencias estándar. Se incorpora a su suscripción cuando decide integrarse.
¿Cómo se mide y se tarifica el uso de la API?
La API se mide por licencia: cada una cubre 1.500 expediciones y 7.500 llamadas a los servicios al año, y permite mantener en la base de datos hasta 5.000 objetos distintos de las expediciones, como productos y participantes (destinatarios, proveedores, conductores y demás). Si prevé más volumen, basta con añadir licencias adicionales. El precio unitario del módulo de API aparece junto al resto del catálogo en nuestra tienda y puede incluirse en cualquier presupuesto a medida.
¿Cuáles son las dos formas de usar la API: por lotes o interactiva?
El modo por lotes recibe la especificación completa de la expedición en una sola llamada, ideal cuando el ERP ya conoce las mercancías, los intervinientes y las cantidades. El modo interactivo permite construir la expedición paso a paso, validando cada mercancía según se añade; se parece más a como funciona la aplicación web y resulta útil cuando necesita flujos guiados por el usuario sobre la API.
¿Conviene crear los productos y los intervinientes por adelantado o sobre la marcha?
Las dos formas son válidas. La recomendada son los datos predefinidos: cree sus mercancías y sus intervinientes una vez en la aplicación web -o impórtelos- y refiéralos por su código desde las llamadas a la API. La definición sobre la marcha permite enviarlo todo en cada llamada, lo que va bien cuando el ERP es el dueño de esos datos y no quiere cargarlos previamente.
¿Cómo obtengo los PDF generados a través de la API?
Hay dos opciones. Puede recibir los documentos en la respuesta de la API como PDF codificados en base64 -documento de transporte, declaración del expedidor, lista de comprobaciones, marcado de bultos, etc.- o hacer que la plataforma los envíe automáticamente por correo a una dirección configurada.
¿Se pueden imprimir automáticamente los documentos generados por la API?
Sí. Funcionan bien dos patrones: que su ERP descargue el PDF de la API y lo envíe a su propia cola de impresión, o que DGAssistant envíe los documentos por correo a un buzón dedicado y una pequeña utilidad de impresión automática los imprima en la impresora que corresponda. Muchos clientes usan el segundo porque no exige código adicional en el ERP.
¿Dónde está la especificación de la API?
La especificación OpenAPI completa, con ejemplos interactivos, está publicada en la documentación de la API de mercancías peligrosas. Facilitamos además un proyecto de SoapUI con llamadas de prueba realistas para que sus desarrolladores puedan explorarla en minutos.
¿Qué es requestGuid y por qué es obligatorio?
Toda llamada a la API debe incluir un requestGuid único que identifica la petición en nuestros registros y permite a nuestro equipo de soporte localizar la transacción exacta cuando usted reporta una incidencia. Se acepta cualquier valor alfanumérico único; recomendamos generar un UUID estándar en el cliente.
¿Cuál es el motivo más frecuente de que falle la primera llamada a la API?
Unas credenciales que el servicio no acepta: que falte la cabecera de autorización HTTP Basic o sea incorrecta o, cuando la llamada se autentica con OAuth2, un testigo de acceso que nunca se solicitó, que pertenece a otro entorno o que ya ha caducado. Existe una dirección de soporte específica que puede invocar para confirmar que la API responde y que sus credenciales son válidas. Si se queda atascado, envíenos la petición y la respuesta HTTP completas -con su requestGuid- y una descripción del comportamiento esperado: es lo que antes desbloquea el problema.