SRR API - программный интерфейс платформы award.srr.ru

Интеграция логгеров и внешних сервисов

Что такое API

SRR API - это программный интерфейс платформы award.srr.ru. Он нужен, чтобы логгеры и внешние сервисы могли обращаться к платформе напрямую: получать справочники, загружать QSO, передавать ADIF-файлы и выгружать подтвержденные или сохраненные связи без ручной работы в браузере.
Для чего это нужно
  • Передавать QSO из логгера сразу после проведения связи или небольшими пачками.
  • Загружать ADIF-файлы так же, как через личный кабинет.
  • Получать единые справочники диапазонов, видов работы, DXCC, RDA, регионов и территорий Р-150-С.
  • Выгружать ADIF по своему или делегированному позывному.
Как авторизоваться

Для обращений используется API key из личного кабинета. Основной способ передачи ключа:

Authorization: Bearer API_KEY
API key определяет пользователя, его подтвержденные позывные и доступы QSL-менеджера.

Версии API

v1
Первая публичная версия
Базовый URL: https://award.srr.ru/api/v1
Тест API Документация
Что нового?
  • GET /me - проверка ключа и получение доступных позывных.
  • GET /info - справочники для логгеров и внешних интеграций.
  • POST /qso - прием одного QSO или небольшой пачки онлайн-связей; ошибки содержат индекс QSO в переданном массиве.
  • Совпадающие QSO из API_ONLINE и ADIF не дублируются; существующие подтверждения сохраняются.
  • POST /qso/uploadADIF - загрузка ADIF-файла в обычную очередь обработки платформы. Поле PROP_MODE необязательно, в том числе для УКВ; требование его заполнения для 2 м и выше действует только при ручном импорте ADIF на сайте. Без поля прохождение остается не указанным, а правила CFM не меняются.
  • GET /qso/export - выгрузка ADIF по позывному и периоду.

Обработка ошибок QSO

Диапазон и вид работы проверяются по справочникам GET /info до помещения QSO в очередь.

Дата и время QSO передаются в UTC. Связь более чем на 10 минут в будущем отклоняется как ошибка исходных данных.

В ответе POST /qso ошибки в validation_errors и process.errors содержат поле index - номер QSO в исходном массиве qsos, начиная с нуля.

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