Pierwsza integracja.
Jasny punkt startu.
Przekaż dane budynku do SZACUN. Poniżej znajdziesz przykładowe żądanie, zasady autoryzacji i zasady obsługi odpowiedzi.
Przygotuj połączenie
Uzyskaj adres środowiska i token
Adres bazowy oraz dane dostępowe otrzymasz w ramach uzgodnionej integracji partnerskiej. W przykładzie zastępują je zmienne środowiskowe.
Wysyłaj żądania z backendu
Token przekazuj w nagłówku Authorization: Bearer. Przechowuj go po stronie serwera, poza kodem przeglądarki i repozytorium.
Przygotuj dane zgodne ze słownikami
Wartości takie jak rodzaj konstrukcji lub źródło ciepła są kodami słownikowymi. Etykiety po polsku w interfejsie nie zastępują tych kodów.
Wybierz operację
| Metoda i ścieżka | Zastosowanie | Uwagi |
|---|---|---|
GET /health | Stan usługi | Bez uwierzytelnienia. Odpowiedź zawiera status, timestamp i version. |
POST /api/audit | Kalkulacja w trybie Advance | 18 pól wymaganych w schemacie. Na tym trybie opiera się przykład. |
POST /api/audit/auto | Tryb Auto | Wymagania danych znajdziesz w katalogu pól dla trybu Auto. |
Wyślij dane budynku
Minimalny przykład Advance opisuje dom o powierzchni 140 m², bez zadeklarowanych prac modernizacyjnych. Pokazuje strukturę poprawnego wejścia, a nie wycenę inwestycji.
{
"property_id": "DEMO-001",
"usable_area_m2": 140,
"construction_year": "1965_1974",
"number_of_occupants": 3,
"construction_type": "heavy",
"building_category": "single_family_building",
"is_insulated": false,
"are_windows_doors_replaced": false,
"current_central_heating_source": "coal_boiler",
"current_hot_water_source": "coal_boiler",
"current_hourly_breaks": "no_breaks",
"current_weekly_breaks": "7_days",
"current_ventilation_type": "natural",
"is_insulation_planned": false,
"windows_doors_replacement_planned": false,
"is_heat_replacement_planned": false,
"is_planned_thermal_collectors": false,
"price_standard": "medium"
}Ustaw adres środowiska w SZACUN_API_URL, token w SZACUN_API_TOKEN i wykonaj żądanie w katalogu z pobranym plikiem.
curl --request POST "$SZACUN_API_URL/api/audit?async_execution=false" \
--header "Authorization: Bearer $SZACUN_API_TOKEN" \
--header "Content-Type: application/json" \
--data-binary @advance-request.jsonObsłuż wynik i błędy
| HTTP | Znaczenie w kontrakcie | Działanie integracji |
|---|---|---|
| 200 | Żądanie obsłużone | Interpretuj odpowiedź zgodnie z uzgodnionym trybem wykonania. |
| 401 | Brak prawidłowego uwierzytelnienia | Sprawdź token i jego ważność. |
| 422 | Dane nie przeszły walidacji | Sprawdź wymagane pola, typy i wartości słownikowe. |
| 500 | Błąd po stronie usługi | Zarejestruj kontekst bez sekretów; uzgodnij bezpieczne zasady ponowień. |
Parametr async_execution jest domyślnie równy false. Przy trybie asynchronicznym kontrakt opisuje potwierdzenie przyjęcia: wymagane pola to message, entry_id i submitted_at.