Przebieg integracji.
Żądanie i odpowiedź.
Jak przekazać dane, obsłużyć odpowiedź i bezpiecznie wykorzystać wynik w Twoim systemie.
Dokumentacja API 7.1. Zakres dokumentacji i zgodność wersji →
Przebieg obsługi kalkulacji
| Krok | Działanie integracji | Podstawa |
|---|---|---|
| Przygotowanie | Uzyskaj adres środowiska, token i uzgodnioną wersję. | Dane Twojego środowiska nie są publikowane w portalu. |
| Walidacja | Sprawdź wejście dla wybranego Advance lub Auto. | Schematy do pobrania i katalog pól. |
| Wysłanie | POST /api/audit lub POST /api/audit/auto; Authorization: Bearer. | Wywołanie z backendu Twojej aplikacji. |
| Wykonanie | async_execution=false jest wartością domyślną. | Parametr zapytania ma typ boolean. |
| Obsługa odpowiedzi | Sprawdź kod HTTP i typ odpowiedzi. | Przyjęcie zlecenia nie potwierdza ukończenia obliczeń. |
| Prezentacja | Pokaż tylko pola o uzgodnionym znaczeniu i jednostce. | Zachowaj zgodność z dokumentacją używanej integracji. |
Potwierdzenie przyjęcia w trybie asynchronicznym
| Pole | Typ i wymagalność | Znaczenie |
|---|---|---|
| message | string; wymagane | Komunikat przyjęcia. |
| entry_id | integer lub string; wymagane | Identyfikator wpisu. Zachowaj typ otrzymany w odpowiedzi. |
| submitted_at | string; wymagane | Czas przyjęcia opisany jako ISO. |
| property_id | string lub null; opcjonalne | Identyfikator nieruchomości. |
| submission_code | string lub null; opcjonalne | Kod zgłoszenia, jeśli został zwrócony. |
Odpowiedź obliczeń i stan usługi
AuditResponse jest obiektem z additionalProperties=true bez zdefiniowanej listy pól wynikowych. Katalog 220 wyników opisuje możliwości modelu; nie jest schematem odpowiedzi wdrożonego API.
GET /health nie wymaga uwierzytelnienia. Zwraca wymagane pola status, timestamp i version. Odpowiedź zdrowia usługi nie potwierdza poprawności konkretnej kalkulacji.
Dodatkowe działania opisane nagłówkami
Nagłówki dodatkowe służą opcjonalnym działaniom, takim jak przygotowanie PDF lub wysyłka raportu. Stosuj je zgodnie z konfiguracją swojej integracji. Przykład startowy ich nie ustawia.
| Nagłówek | Przeznaczenie | Sposób użycia |
|---|---|---|
| X-Save-To-Drive | Zapis danych do Drive. | Wartość tekstowa zgodna z konfiguracją integracji. |
| X-Generate-Pdf | Generowanie PDF. | Wartość tekstowa zgodna z konfiguracją integracji. |
| X-Save-Pdf-To-Drive | Zapis PDF do Drive. | Wartość tekstowa zgodna z konfiguracją integracji. |
| X-Send-Email | Wysłanie wiadomości. | Wartość tekstowa zgodna z konfiguracją integracji. |
Przetwarzanie i przechowywanie danych
W usłudze SZACUN dane służą wykonaniu obliczeń, przygotowaniu i przechowywaniu raportów, ich wysyłce oraz obsłudze technicznej. W modelu powierzenia Twoja instytucja jest administratorem danych, a Adenergo przetwarza je w jej imieniu na podstawie umowy.
Aplikacja korzysta z Google Cloud Platform w regionie Warszawa. Przy włączonym zapisie kalkulacje i raporty trafiają do firmowego Google Workspace Adenergo: Google Drive/Sheets. Raporty są wysyłane przez pocztę Google. Dostęp administracyjny mają upoważnione osoby techniczne. Region aplikacji nie określa lokalizacji wszystkich usług Google Workspace.
Przyjęty okres przechowywania wynosi 6 miesięcy dla poniższych kategorii. Zasady dotyczą usługi obliczeniowej SZACUN; nie opisują przechowywania danych odwiedzających ten portal informacyjny.
| Kategoria danych | Przyjęty okres przechowywania |
|---|---|
| Kalkulacje | 6 miesięcy |
| Raporty PDF | 6 miesięcy |
| Logi techniczne | 6 miesięcy |
| Kopie zapasowe | 6 miesięcy |
Błędy i ponowienia
| Sytuacja | Zalecane działanie | Na co zwrócić uwagę |
|---|---|---|
| 401 | Sprawdź ważność i konfigurację tokenu. | Przechowuj token po stronie serwera. |
| 422 | Pokaż błąd danych; popraw typ, kod lub brakującą wartość. | Sprawdź odpowiedź walidacji dla danego żądania. |
| 500 | Zachowaj identyfikator sprawy i kontekst bez sekretów. | Stosuj zasady ponowień przyjęte dla integracji. |
| Przerwane połączenie | Potraktuj stan wykonania jako nieznany. | Sprawdź status zgłoszenia przed ponowną wysyłką, aby uniknąć powielenia działań. |
| 200 z potwierdzeniem | Zachowaj identyfikator i czas przyjęcia. | Potwierdzenie przyjęcia nie jest pełnym wynikiem analizy. |
Przygotowanie połączenia
Adres środowiska, dane dostępowe i zakres obsługiwanych działań otrzymasz w ramach integracji partnerskiej. Zastosuj uzgodnione zasady odbioru wyników, ponowień i przechowywania danych.