Zarządzanie dostępem do dokumentacji API

Dokumentacja API platformy Welyo jest dostępna z poziomu panelu administratora. Jeśli jednak konieczne jest przekazanie jej osobie spoza platformy (np. zewnętrznemu kontraktorowi przygotowującemu integrację), można wygenerować dedykowany link dostępu do dokumentacji API bez konieczności nadawania uprawnień administratora.

Wygenerowany link może być czasowy lub bezterminowy, w zależności od wybranych ustawień.

Jak wygenerować link do dokumentacji API?

1. Zaloguj się do platformy Welyo jako administrator.
2. Przejdź do sekcji: Administracja > Integracje > Dokumentacja API (zarządzanie dostępem).
3. Kliknij Generuj.

4. Wybierz czas ważności linku.

   

5. Skopiuj wygenerowany link i przekaż go osobie, która potrzebuje dostępu do dokumentacji.

Zarządzanie dostępem do dokumentacji

W oknie Dokumentacja API (zarządzanie dostępem) administrator może:

• wygenerować nowy link do dokumentacji API,
• wyświetlić aktualny link,
• zablokować istniejący link.

Ważne informacje

• Wygenerowanie nowego linku powoduje unieważnienie poprzedniego linku do dokumentacji API.
• Po wygenerowaniu linku nie można wydłużyć jego czasu ważności. Jeśli dostęp wygaśnie, należy wygenerować nowy link.
• Link można w dowolnym momencie zablokować, co natychmiast uniemożliwi dostęp do dokumentacji osobom, które go posiadają.

Dobra praktyka bezpieczeństwa

Udostępniaj link do dokumentacji API tylko osobom odpowiedzialnym za integrację systemów. Jeśli współpraca z kontraktorem zakończy się lub istnieje ryzyko nieautoryzowanego dostępu, zaleca się zablokowanie aktywnego linku i wygenerowanie nowego w razie potrzeby.