Dokumentacja HAMBOOK API

Zintegruj swoje oprogramowanie krótkofalarskie z dziennikiem hambook.site

Autoryzacja i bezpieczeństwo

Do pracy z API potrzebny jest osobisty klucz API Key. Wszystkie żądania API muszą być wykonywane w kontekście konkretnego użytkownika serwisu.

Jak uzyskać klucz API:
  1. Zaloguj się do swojego Panelu na portalu hambook.site.
  2. Przejdź do zakładki 'Ustawienia' i znajdź sekcję 'Klucze API'.
  3. Wpisz nazwę swojej aplikacji i kliknij przycisk 'Generuj klucz'.
Format żądania HTTP

Transmisja danych QSO odbywa się za pomocą standardowego żądania POST. Klucz autoryzacji musi być przekazany w nagłówku HTTP lub jako parametr 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]

Akceptowane parametry żądania

Dane powinny być przesyłane w formacie application/x-www-form-urlencoded (standardowe żądanie POST).

Parameter Type Required Description / Example
call string YES Znak korespondenta (zostanie automatycznie zamieniony na wielkie litery).
Example: W1AW, R3TJL/3
my_call string No Twój znak (stacja). Jeśli jest pusty — automatycznie użyty zostanie główny znak użytkownika z profilu.
Example: R8LCA
band string No Pasmo w formacie ADIF (zostanie automatycznie zamienione na wielkie litery).
Example: 20m, 40m, 2m
mode string No Rodzaj emisji (mode) w formacie ADIF.
Example: CW, SSB, FT8
submode string No Podrodzaj emisji (dla FT4, PSK31 itp.).
Example: FT4
freq float No Dokładna częstotliwość w MHz.
Example: 14.074
qso_date string No Data łączności w formacie RRRRMMDD. Jeśli pusta — zostanie użyta aktualna data.
Example: 20260623 (YYYYMMDD)
time_on string No Czas rozpoczęcia łączności w formacie GGMM (UTC). Jeśli pusty — zostanie użyty aktualny czas.
Example: 1753 (HHMM, UTC)
rst_sent string No Wysłany raport RST.
Example: 599, -12 (Default: 59)
rst_rcvd string No Otrzymany raport RST.
Example: 59, -08 (Default: 59)
gridsquare string No Lokator korespondenta.
Example: FN31, LO06ff
my_gridsquare string No Twój lokator podczas łączności.
Example: LO06ee
qth string No Miasto/lokalizacja korespondenta.
Example: Nizhny Novgorod
name string No Imię korespondenta.
Example: John
comment string No Własny komentarz do łączności.
Example: QRP 5W, dipole

Formaty odpowiedzi serwera (JSON)

API hambook.site zawsze zwraca odpowiedź w formacie JSON z kodem statusu HTTP 200, nawet w przypadku błędów.

Pomyślnie zapisano 
{
  "status": "success",
  "id": 471295
}
Wykryto duplikat (zignorowano) 
{
  "status": "success",
  "message": "Duplicate ignored",
  "id": 471294
}
Błąd autoryzacji 
{
  "status": "error",
  "message": "Invalid API Key"
}

Przykłady integracji kodu

<?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)