Клиентский API
Подключите вашу ERP-систему напрямую к Feronix — REST, JSON через HTTPS, привязка к арендатору, идемпотентность и предварительная проверка.
Данные, переданные через API, растаможиваются Feronix под собственной EORI и собственными счетами отсрочки. Вы как клиент передаёте данные поставок и отправок; Feronix осуществляет таможенную декларацию как декларант и представитель. Товары доставляются напрямую на склад Feronix.
Когда использовать API
Клиентский API — это путь для автоматизированной передачи из ERP-систем (SAP, Microsoft Dynamics, Odoo, Oracle) и для всех сценариев интеграции, в которых вы хотите автоматически передавать поставки, манифесты посылок, данные отправлений и документы. Он заменяет ручной ввод на портале и обеспечивает сквозную автоматизацию от ERP до таможни. Переданные поставки предназначены для склада Feronix; Feronix выступает как декларант и представитель в таможенной процедуре.
Поддерживаемые форматы ввода
- Структурированные REST-пакеты — JSON через HTTPS
- JSON — для отдельных данных и небольших пакетов
- CSV — для массового импорта данных
- Поставки NOVA-POSHTA — в формате NOVA строки товаров консолидируются по номеру посылки в физические посылки и их базовые товарные позиции
Конфликтующие мастер-данные посылок, дублирующиеся или отсутствующие назначения, недействительные суммы, вес, коды HS и компоненты адреса обнаруживаются до создания.
Аутентификация
curl -H 'X-Api-Key:' \ -H 'Accept-Language: de' \ https://atlas.feronix.tech/customer/me
Ключ определяет арендатора на стороне сервера. customer_id
в теле запроса никогда не должен расширять эту область. Поддерживаемые языки:
de, en, fr, es, zh, ru, uk.
Чем вы можете управлять через API
- Создать поставку
- Передать данные поставки и транспорта
- Импортировать список посылок или товарный манифест
- Консолидировать посылки и товарные позиции
- Загрузить и назначить счета-фактуры, подтверждения стоимости, T1 и другие документы
- Получить результаты проверки
- Явно подать декларацию IMPOST
- Запросить статус, ошибки, сообщения и документы
- Исправить ошибочные данные и повторно отправить с новым номером сообщения
Рекомендуемая последовательность
- Определить случай T1 — если существует действующая транзитная процедура,
сначала
POST /warehouse/delivery-documents/t1. Если новый T1 должен быть создан, установитеt1_mode=createв поставке. - Создать поставку —
POST /warehouse/delivery-manifestsдля поставки, включая срок и полный список посылок. - Загрузить подтверждение стоимости —
POST /warehouse/value-evidenceдля счёта-фактуры/подтверждения стоимости. - Предварительная проверка —
POST /customer/shipments/validateдля предварительной проверки. Успешная проверка ничего не отправляет в таможню. - Создать отправку —
POST /customer/shipmentsдля создания/отправки согласно телу запроса. - Отслеживать статус —
GET /customer/shipments/{lrn}и таможенный процесс черезGET /customer/declarations/{lrn}. - Сгенерировать T1 — с
t1_mode=createпосле полного ввода сгенерируйте T1 черезPOST /warehouse/deliveries/{delivery_number}/t1-xml.
Идемпотентность
Ключи идемпотентности предотвращают дублирующее создание при сетевых или повторных попытках сканера. Логически идентичный повтор должен использовать тот же внешний ссылочный или идемпотентный идентификатор. Исправленная повторная отправка получает новый номер сообщения ATLAS. Тайм-аут — это не то же самое, что отказ — перед повторной попыткой проверьте, был ли запрос принят и только ответ был потерян.
Основные эндпоинты
| Метод | Эндпоинт | Назначение |
|---|---|---|
| POST | /warehouse/delivery-manifests | Создать поставку и посылки атомарно (поставка на склад Feronix) |
| POST | /warehouse/value-evidence | Загрузить подтверждение стоимости |
| POST | /customer/shipments/validate | Предварительная проверка (ничего не отправляет в таможню) |
| POST | /customer/shipments | Создать/отправить отправку |
| GET | /customer/shipments/{lrn} | Статус отправки |
| GET | /customer/shipments/{lrn}/impost-xml | Экспорт IMPOST-XML (ICOMDA) |
| GET | /customer/shipments/{lrn}/standard-clearance/dossier.pdf | PDF таможенного досье |
| GET | /customer/shipments/{lrn}/standard-clearance/dossier.zip | ZIP таможенного досье |
| POST | /customer/shipments/{lrn}/standard-clearance/atlas-xml | Сгенерировать DECDFA-XML |
| GET | /customer/declarations/{lrn} | Таможенный процесс с сообщениями и решением |
| POST | /customer/declarations/{lrn}/resubmit | Исправленная повторная отправка |
| POST | /customer/suma/xml | Экспорт SumA-XML |
| POST | /warehouse/transit-orders | Создать транзитный заказ |
| POST | /warehouse/transit-orders/{id}/xml | Сгенерировать T1-XML (DETPDD) |
| POST | /customer/customs-xml/validate | Проверка XML по оригинальному XSD |
| GET | /customer/me | Профиль арендатора |
| GET | /customer/me/identities | Таможенные идентичности (EORI/NL) — таможенные идентичности Feronix, под которыми Feronix выступает как декларант, а не ваши |
| GET | /customer/me/mandates | Мандаты на представительство — мандаты, под которыми Feronix выступает для вас как представитель в таможенной процедуре |
| GET | /customer/reference/hs-search | Поиск кода HS |
Коды ошибок
Ошибки API содержат HTTP-статус, стабильный код ошибки, локализованный текст и, по возможности, путь к затронутому полю.
| Статус | Значение | Действие |
|---|---|---|
| 400 | Запрос технически нечитаем | Проверьте JSON, кодировку или файл |
| 401 | API-ключ отсутствует или недействителен | Отправьте X-Api-Key правильного арендатора |
| 403 | Отсутствует разрешение | Проверьте роль пользователя или одобрение API |
| 404 | Объект не найден у арендатора | Проверьте LRN, номер поставки, штрих-код и арендатора |
| 409 | Логический конфликт | Исправьте статус, уникальность или зависимые данные |
| 422 | Нарушено обязательное поле/зависимость | Полностью обработайте подсказки по полям |
| 500/502/503 | Техническая ошибка | Не отправляйте вслепую — повторите с тем же ключом идемпотентности |