Интеграция ApiShip по API

В ApiShip создаётся заказ на доставку: получатель с именем, телефоном и почтой, город и адрес из полей формы.

Из настройки интеграции: order.clientNumber, order.providerKey, order.pickupType, order.deliveryType, order.tariffId, order.weight.

Запрос в ApiShip: POST https://api.dev.apiship.ru/v1/orders.

curl -X POST https://woove.ru/hook/api/<ваш ключ> \
  -H 'Content-Type: application/json' \
  -d '{
    "Name": "Юлия Ковалёва",
    "Phone": "+7 950 614-29-87",
    "Email": "yu.kovaleva@example.ru",
    "Comment": "Позвоните перед доставкой",
    "City": "Екатеринбург",
    "Address": "ул. Малышева, 51, кв. 12",
    "tranid": "order-1001"
  }'

1. Доступ в ApiShip

   Логин и пароль кабинета ApiShip, код службы и номер тарифа.

   • Зарегистрируйтесь на apiship.ru, аккаунт заводится сам
   • Логин и пароль от кабинета и есть доступ к API: токен мы получаем сами при каждой отправке
   • Код службы доставки берётся из списка перевозчиков в кабинете, например cdek или dpd
   • Номер тарифа даёт расчёт стоимости: сделайте его в кабинете и запишите tariffId нужного варианта
   • Для проб есть тестовый контур с отдельным адресом, заказы в нём не уходят перевозчику

   Где взять доступ к ApiShip

2. Интеграция в кабинете

   В кабинете откройте «Connect» и подключите ApiShip. На вкладке «Настройка» в поле «Источник заявок» выберите «API» и нажмите «Скопировать». Там же заполните блок «Доступ».

3. Отправка из вашего кода

   • Отправляйте POST на адрес вебхука из кабинета с JSON-телом: {"Name": "…", "Phone": "…", "Email": "…", "Comment": "…"} и любыми своими полями.
   • В ответ придёт {"ok": true}. Повторы с одинаковым tranid отбрасываются.
   • Заявка с ошибкой настройки появится на вкладке «Заявки» со статусом «Не разобрано» и причиной.

   Тело читается как JSON, если в заголовке Content-Type указан application/json. Иначе Woove разбирает его как форму. Вложенный JSON разворачивается в плоские поля. Массив пар с подписью и значением превращается в поля с этими подписями. Запрос можно отправлять из браузера: заголовки CORS разрешают POST с любого домена. Поля _redirect, _thanks, _source и _gotcha служебные, в заявку они не попадают. Запрос с одним полем test записывается как проверочный и в сервис не уходит.

   • 200 {"ok":true}: заявка принята
   • 404 unknown hook: ключа из адреса нет ни у одной интеграции
   • 413 too large: тело запроса больше 256 КБ
   • GET на адрес вебхука: отвечает ok, заявку не создаёт

   Повтор отбрасывается, если заявка с таким tranid уже принята или отправлена. Заявка с ошибкой настройки повтор не блокирует.

   Для ApiShip добавьте в JSON:

   • поле "City"
   • поле "Address"

4. Поля формы

   Ключи JSON — имена полей.

   Менять ничего не нужно: имена полей совпадают с теми, что Woove ждёт по умолчанию.

5. Проверка

   Отправьте запрос из примера. На вкладке «Заявки» у неё будет статус «Черновик» и то, что уйдёт в ApiShip. Затем выключите «Черновой режим» на вкладке «Настройка».

   API и Woove Connect: заявки с форм в CRM и мессенджеры