Авторизация запроса

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

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

Для дополнительной безопасности рекомендуется передавать свои запросы по протоколу SSL (Secure Sockets Layer), используя HTTPS. SSL шифрует передачу, защищая запрос или ответ от просмотра при пересылке.

Аргументы для авторизации запроса

Для любого запроса API базы знаний KBPublisher необходимо включить 3 аргумента. Это позволит вам авторизировать запрос.
Ниже описано как генерируется каждое значение:

accessKey
Параметр accessKey определяет, кто делает запрос.
Получить это значение можно со страницы учетной записи в папке установки KBPublisher. Перейдите в Панели администратора: Мой аккаунт ->Настройки API -> Публичный ключ API.

timestamp
Параметр timestamp показывает, когда был создан запрос. В параметре задается число секунд (по Unix-времени), когда был сгенерирован запрос, и это значение должно легко генерироваться на большинстве языков программирования. API будет отклонять запросы, которые были созданы в слишком отдаленном прошлом, поэтому важно поддерживать синхронизацию запросов компьютера с NTP.

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

Генерация подписи

Чтобы создать подпись, начните с определения метода HTTP и URL-адреса запроса.

• Метод запроса почти всегда будет GET или POST для запросов API KBPublisher.
  Метод HTTP ‒ GET

• Основной URL-адрес ‒ это URL-адрес, на который отправлен запрос, минус протокол ("http://" или "https://") и любая строка запроса.
  URL ‒ domain.com/kb_directory/api.php 

Затем соберите все параметры GET, входящие в запрос. Эти значения должны быть закодированы в одну строку, которая будет использоваться позже. Процесс построения строки очень специфичен:

• Отсортируйте список параметров по алфавиту с помощью ключа.
• Объедините параметры в строку следующим образом: key=value&key2=value2... и т.д.
• Закодируйте URL-строку параметров.

Наконец, подпись вычисляется путем передачи базовой строки подписи и ключа подписи к алгоритму хеширования HMAC-SHA1 и добавляется к запросу. Реализация HMAC-SHA1 доступна для каждого популярного языка. Например, PHP имеет функцию hash_hmac.

• $signature = rawurlencode(base64_encode(hash_hmac("sha1", $string_to_sign, $secret_api_key, true)));
   

Пример подписи запроса в PHP

Запрос для приведенного выше примера будет выглядеть следующим образом: