API and ERP integration
How DGAssistant fits into your ERP, WMS or shipping platform.
Do I need a special module to use the API?
Yes, the API is a separately licensed module on top of your standard licenses. You add it to your subscription when you decide to integrate.
How is API usage measured and priced?
The API is metered by license: each one covers 1,500 shipments and 7,500 service calls per year, and allows the database to hold up to 5,000 objects other than shipments, such as products and participants (consignees, suppliers, drivers and the rest). If you expect more volume you simply add additional licenses. The exact unit price for the API module is shown alongside the rest of the catalog in our store and can be included in any custom quote.
What are the two ways to use the API: Batch vs Interactive?
Batch mode receives the full shipment specification in a single service call — ideal when the ERP already knows the goods, participants and quantities. Interactive mode lets you build the shipment step by step, validating each good as you add it; this is closer to how the web application works and is useful when you need user-driven workflows on top of the API.
Should I create products and participants in advance, or "on the fly"?
Both are supported. The recommended approach is "predefined data": create your goods and participants once in the web application (or import them) and reference them by code from your API calls. The "on the fly" approach lets you push everything in each call, which is convenient when your ERP is the master of that data and you don't want to pre-load it.
How do I retrieve generated PDFs through the API?
There are two options. You can receive the documents in the API response as base64-encoded PDFs (transport document, shipper's declaration, checklist, package marking, etc.), or you can have the platform send them automatically by email to a configured address.
Can I print API-generated documents automatically?
Yes. Two patterns work well: (a) your ERP downloads the PDF from the API and sends it to its own print queue; (b) DGAssistant emails the documents to a dedicated mailbox and a small auto-print utility on your side prints them on the right printer. Many customers use the email pattern because it requires no additional code on the ERP side.
Where is the API specification?
The complete OpenAPI specification, with interactive examples, is published in the dangerous goods API documentation. We also provide a SoapUI project preloaded with realistic test calls so your developers can explore the API in minutes.
What is requestGuid and why is it required?
Every API call must include a unique requestGuid that identifies the request in our logs and allows our support team to find the exact transaction when you report an issue. Any unique alphanumeric value is accepted; we recommend generating a standard UUID/GUID on the client side.
What's the most common reason an API call fails on first try?
Credentials that the service does not accept: either a missing or wrong HTTP Basic Authorization header or, when the call is authenticated with OAuth2, an access token that was never requested, that belongs to another environment or that has already expired. There is a dedicated support URL you can hit to confirm the API is alive and your credentials are valid. If you are stuck, send us the full HTTP request and response (including requestGuid) and a description of the expected behavior — that is what unblocks the issue fastest.