Главная/Словарь терминов/API (интерфейс прикладного программирования)
ГЛОССАРИЙ ТЕРМИНАЛ

API (интерфейс прикладного программирования)

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

Оцените весь рабочий процесс.

Рассмотрим финансовую команду, которой необходимо получить окончательные ежемесячные комиссионные выплаты по партнерам и валютам. Полезным будет оценить, предоставляет ли API информацию о статусе завершения расчетов, корректировках, постраничной навигации, исторических периодах и стабильном идентификаторе партнера. Конечная точка, возвращающая текущую сумму прибыли, не обязательно соответствует этому требованию.

Запишите входные данные, ожидаемый результат, права доступа, объем и сценарий сбоя для каждой запланированной задачи. Протестируйте реалистичные размеры учетных записей. Успешное получение первых ста записей мало что говорит о том, сможет ли ночная задача получить два миллиона записей в рамках разрешенного бюджета запросов.

Отдельный доступ от властей

Интеграция системы отчетности должна получать только необходимые разрешения. Разрешение на чтение данных о комиссионных не подразумевает разрешения на изменение ставок, утверждение платежей или получение документов, удостоверяющих личность. Храните учетные данные вне общедоступных страниц и журналов и предоставьте документированный способ их обновления или отзыва.

Проверьте, как отображаются ошибки. Интеграция должна различать недействительный запрос, отсутствие авторизации, временный сбой сервиса и ограничение скорости запросов. Повторная попытка при каждой ошибке может скрывать проблемы с конфигурацией или повторять финансовую операцию. Для действий, изменяющих данные, определите, как обнаруживаются дубликаты отправленных данных.

Версионирование и определения полей имеют значение с течением времени. Записывайте поддерживаемую версию API, политику обновления, часовой пояс, валюту и значение полей статуса. Изменение поля с валового дохода на чистый без очевидного изменения названия может навредить отчетности, даже если все запросы по-прежнему выполняются успешно.

Изучите REST API для интерфейсов ресурсов на основе HTTP, API для формирования отчетов и веб-хуки для уведомлений о событиях. Практическим критерием является не способность поставщика продемонстрировать хотя бы один успешный запрос, а способность интерфейса надежно поддерживать предполагаемый бизнес-процесс, включая его исключительные случаи.

Источник: MDN: Определение API .

← Назад к глоссарию
Запросить демо
ШАГ 1 3 г.
Спасибо — вы в очереди.
Специалист компании NowG свяжется с вами в течение одного рабочего дня, чтобы согласовать время осмотра помещения.