Документация HAMBOOK API

Интеграция вашего радиолюбительского софта с аппаратным журналом hambook.site

Авторизация и безопасность

Для работы с API вам необходим персональный ключ API Key. Все запросы к API должны выполняться в контексте конкретного пользователя сайта.

Как получить ваш API-ключ:
  1. Зайдите в Личный кабинет на портале hambook.site.
  2. Перейдите на вкладку «Настройки» и найдите раздел «Ключи API».
  3. Укажите название вашего приложения и нажмите кнопку «Сгенерировать ключ».
Формат HTTP-запроса

Передача данных QSO выполняется стандартным POST-запросом. Ключ авторизации должен передаваться в HTTP-заголовке либо в виде GET-параметра.

Method POST
Endpoint URL https://hambook.site/api/v1/qso/
Auth Header X-Hambook-Key: [your_api_key]
Alternative GET Auth https://hambook.site/api/v1/qso/?key=[your_api_key]

Принимаемые параметры запроса

Данные должны передаваться в формате application/x-www-form-urlencoded (обычный POST-запрос с формы).

Parameter Type Required Description / Example
call string YES Позывной корреспондента (будет автоматически переведен в верхний регистр).
Example: W1AW, R3TJL/3
my_call string No Ваш позывной (станция). Если пуст — автоматически подставится основной позывной пользователя из профиля.
Example: R8LCA
band string No Диапазон связи в ADIF-формате (будет автоматически переведен в верхний регистр).
Example: 20m, 40m, 2m
mode string No Вид модуляции (вид работы) в ADIF-формате.
Example: CW, SSB, FT8
submode string No Подвид модуляции (для FT4, PSK31 и др.).
Example: FT4
freq float No Точная частота связи в МГц.
Example: 14.074
qso_date string No Дата проведения связи в формате ГГГГММДД. Если пуста — подставится текущая дата.
Example: 20260623 (YYYYMMDD)
time_on string No Время начала связи в формате ЧЧММ (по UTC). Если пустое — подставится текущее время.
Example: 1753 (HHMM, UTC)
rst_sent string No Переданный RST (рапорт).
Example: 599, -12 (Default: 59)
rst_rcvd string No Полученный RST (рапорт).
Example: 59, -08 (Default: 59)
gridsquare string No QTH-локатор корреспондента.
Example: FN31, LO06ff
my_gridsquare string No Ваш QTH-локатор во время связи.
Example: LO06ee
qth string No Город/местонахождение корреспондента.
Example: Nizhny Novgorod
name string No Имя корреспондента.
Example: John
comment string No Произвольный комментарий к QSO.
Example: QRP 5W, dipole

Форматы ответов сервера (JSON)

API hambook.site всегда возвращает ответ в формате JSON с HTTP-статусом 200, даже в случае ошибок.

Успешная запись 
{
  "status": "success",
  "id": 471295
}
Обнаружен дубликат (пропущен) 
{
  "status": "success",
  "message": "Duplicate ignored",
  "id": 471294
}
Ошибка авторизации 
{
  "status": "error",
  "message": "Invalid API Key"
}

Примеры интеграции в код

<?php
$ch = curl_init('https://hambook.site/api/v1/qso/');
$data = [
    'call' => 'W1AW',
    'band' => '20m',
    'mode' => 'CW',
    'rst_sent' => '599',
    'rst_rcvd' => '599',
    'comment' => 'Logged via API'
];

curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($data));
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'X-Hambook-Key: YOUR_API_KEY_HERE'
]);

$response = curl_exec($ch);
curl_close($ch);

$result = json_decode($response, true);
print_r($result);
?>
import requests

url = 'https://hambook.site/api/v1/qso/'
headers = {
    'X-Hambook-Key': 'YOUR_API_KEY_HERE'
}
data = {
    'call': 'W1AW',
    'band': '20m',
    'mode': 'CW',
    'rst_sent': '599',
    'rst_rcvd': '599',
    'comment': 'Logged via Python API'
}

response = requests.post(url, headers=headers, data=data)
result = response.json()
print(result)