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

Основные параметры API #

Боевая и тестовая среды используют разные базы данных. Сущность, созданная в одной среде, не доступна в другой.

Справочники также имеют разное содержание.

Боевая среда #

• Адрес отправления запросов: https://api.apiship.ru/v1/
• Интерактивная документация доступна по адресу: https://api.apiship.ru/doc/
• PHP SDK доступен по адресу: https://github.com/apiship/apiship-sdk-php

Тестовая среда #

• Адрес отправления запросов: http://api.dev.apiship.ru/v1/
• Интерактивная документация доступна по адресу: http://api.dev.apiship.ru/doc/
• ЛК для тестовой среды: http://a.dev.apiship.ru/
• Логин и пароль для тестов: test

Как использовать интерактивную документацию #

Поддерживаемые форматы данных #

Для указания формата данных вашего запроса к API необходимо указать корректное значение для заголовка Content-Type. Для указания формата в котором вы хотите получить ответ необходимо указать значение для заголовка Accept.

Все данные должны быть в кодировке UTF-8

Авторизация #

С каждым запросом необходимо передавать API токен в http заголовке Authorization. Токен возможно получить методом POST /login

В текущей версии API время жизни токена не проверяется, поэтому вы можете один раз получить токен и использовать его в дальнейшем неограниченное время.

Пример заголовка #

Authorization: 57fa8b7cb32530a0405bed4fbc8cb983

Примеры curl запросов #

Файлы request.json и request.xml должны содержать тело запроса в json или xml формате соответственно.

1
2
3
4
5

curl -X "POST" "https://api.apiship.ru/v1/<адрес_метода>" \
     -H 'Accept: application/json' \
     -H 'Authorization: <токен_авторизации>' \
     -H 'Content-Type: application/json' \
     -d @request.json

1
2
3
4
5

curl -X "POST" "https://api.apiship.ru/v1/<адрес_метода>" \
     -H 'Accept: application/xml' \
     -H 'Authorization: <токен_авторизации>' \
     -H 'Content-Type: application/xml' \
     -d @request.xml

Ошибки #

Структура ответа API #

Пример ошибок #

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12

{
  "code": "040000",
  "message": "Ошибка валидации",
  "description": "Общая ошибка валидации, смотрите документацию",
  "moreInfo": "Вопросы пишите на адрес support@apiship.ru",
  "errors": [
    {
      "field": "`login`",
      "message": "Атрибут `login` обязателен для заполнения."
    }
  ]
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12

<response>
<code>040000</code>
<message>Ошибка валидации</message>
<description>Общая ошибка валидации, смотрите документацию</description>
<moreInfo>Вопросы пишите на адрес support@apiship.ru</moreInfo>
<errors>
<item>
<field>`login`</field>
<message>Атрибут `login` обязателен для заполнения.</message>
</item>
</errors>
</response>

Возможные коды ошибок #