API — согласованный способ взаимодействия
Одна система отправляет запрос, другая выполняет разрешённое действие или возвращает данные в определённом формате. Например, сайт передаёт сохранённое обращение в CRM. Интерфейс описывает методы, поля и ошибки.
Документация не равна доступу
Метод может зависеть от прав приложения, тарифа, версии или настроек аккаунта. Поэтому перед оценкой интеграции проверяют конкретную систему. Секретные ключи должны храниться на сервере, а не в коде страницы.
Самое важное часто происходит при ошибке
Запрос может завершиться отказом или потерять ответ после выполнения. Повтор иногда создаёт дубль. Нужны идентификаторы, журнал операций и согласованная стратегия повтора, особенно для оплаты и создания заказов.
Что передать разработчику
Список систем, направление обмена, образец данных и ожидаемый результат. Отдельно уточните, кто владеет каждым полем и что делать при конфликте. Не отправляйте действующие ключи в открытой форме на сайте.
Полезно для следующего шага
Опишите результат, который нужен бизнесу, и ограничения текущего процесса. Это поможет оценить необходимый объём.
Описать задачуМатериалы для углубления
Документация Unisender Go: пример API и обработки статусов ↗