API и интеграция с ERP
Как DGAssistant встраивается в вашу ERP, складскую систему или платформу отправок.
Нужен ли отдельный модуль, чтобы пользоваться API?
Да, API — это отдельно лицензируемый модуль в дополнение к вашим обычным лицензиям. Вы добавляете его в подписку, когда решаете интегрироваться.
Как измеряется и оплачивается использование API?
API считается по лицензии: каждая покрывает 1 500 отправок и 7 500 вызовов служб в год и позволяет базе данных хранить до 5 000 объектов, не являющихся отправками, — грузы и участников (получателей, поставщиков, водителей и прочих). Если ожидается больший объём, вы просто добавляете лицензии. Точная цена единицы модуля API указана рядом с остальным каталогом в нашем магазине и может быть включена в любое индивидуальное предложение.
Каковы два способа работы с API: пакетный и диалоговый?
В пакетном режиме API получает полное описание отправки одним вызовом службы — это удобно, когда ERP уже знает грузы, участников и количества. Диалоговый режим позволяет собирать отправку шаг за шагом, проверяя каждый груз при добавлении; он ближе к работе веб-приложения и полезен, когда поверх API нужны сценарии, которыми управляет пользователь.
Создавать грузы и участников заранее или передавать их на лету?
Возможно и то и другое. Рекомендуемый подход — «заранее заданные данные»: создайте грузы и участников один раз в веб-приложении (или загрузите их) и ссылайтесь на них по коду в вызовах API. Подход «на лету» позволяет передавать всё в каждом вызове, что удобно, когда источником этих данных служит ваша ERP и заранее загружать их вы не хотите.
Как получить созданные файлы PDF через API?
Есть две возможности. Вы можете получать документы в ответе API как файлы PDF в кодировке base64 (транспортный документ, декларация грузоотправителя, контрольный список, маркировка упаковок и прочее) либо поручить платформе самой отправлять их по электронной почте на настроенный адрес.
Можно ли печатать созданные через API документы автоматически?
Да. Хорошо работают два способа: (а) ваша ERP получает файл PDF через API и отправляет его в собственную очередь печати; (б) DGAssistant отправляет документы на отдельный почтовый ящик, а небольшая программа автоматической печати на вашей стороне выводит их на нужный принтер. Многие клиенты выбирают путь через почту, поскольку он не требует дополнительного кода на стороне ERP.
Где находится спецификация API?
Полная спецификация OpenAPI с интерактивными примерами опубликована в документации API для опасных грузов. Кроме того, мы предоставляем проект SoapUI с реалистичными тестовыми вызовами, чтобы ваши разработчики могли изучить её за несколько минут.
Что такое requestGuid и почему он обязателен?
Каждый вызов API должен содержать уникальный requestGuid, который обозначает запрос в наших журналах и позволяет нашей поддержке найти именно ту операцию, о которой вы сообщаете. Принимается любое уникальное буквенно-цифровое значение; советуем создавать на стороне клиента обычный UUID/GUID.
Какая самая частая причина неудачи вызова API с первой попытки?
Учётные данные, которые служба не принимает: отсутствующий или неверный заголовок HTTP Basic Authorization либо, если вызов проходит проверку по OAuth2, токен доступа, который никогда не запрашивался, принадлежит другой среде или уже истёк. Есть отдельный адрес поддержки, обратившись к которому можно убедиться, что API отвечает, а учётные данные действительны. Если дело не движется, пришлите нам полный запрос и ответ HTTP (вместе с requestGuid) и описание ожидаемого поведения — так вопрос решается быстрее всего.