Jak opisać integrację
Lista informacji potrzebnych do odtworzenia połączenia z usługą.
To przewodnik redakcyjny. Nie opisuje istniejącego API NQ2 — konkretne adresy, parametry i wymagania uzupełnij na podstawie wdrażanej integracji.
Cel i wymagania
Opisz, jakie dane przepływają między aplikacją a usługą, w którym kierunku i kiedy. Podaj wymaganą wersję aplikacji oraz uprawnienia konta.
Konfiguracja
Wymień pola ustawień i ich znaczenie. W przykładach stosuj wartości zastępcze, np. YOUR_TOKEN, zamiast rzeczywistych sekretów.
Przykładowe żądanie i odpowiedź
Dodaj minimalny przykład, który można odtworzyć. Określ metodę HTTP, ścieżkę, format danych i spodziewany kod odpowiedzi. Jeżeli dołączasz konfigurację, umieść ją obok tego pliku Markdown i dodaj odnośnik.
Obsługa błędów
Opisz najczęstsze błędy uwierzytelniania, limity usługi, zasady ponawiania oraz sposób weryfikacji, czy synchronizacja się powiodła.