Was ist eine API-Schnittstelle in Skava?

Ein Formular, dessen ausgefüllte Werte Skava als JSON an eine von dir hinterlegte https://-Adresse (dein Backend) sendet — praktisch, um Skava mit eigenen Systemen zu verbinden.

Wer darf API-Schnittstellen anlegen und auslösen?

Anlegen und Bearbeiten ist Firmen-Admins vorbehalten. Eine freigegebene Schnittstelle können anschließend alle Mitglieder der Firma auslösen.

Was ist der Unterschied zwischen „Ping“ und „Test-Request“?

Ping prüft nur, ob die Adresse erreichbar ist — ohne Token und ohne Daten. Test-Request sendet Beispieldaten inklusive Token und zeigt die vollständige Antwort.

Ist mein API-Token sicher?

Ja. Der Token wird verschlüsselt gespeichert und nie an Clients ausgeliefert. Die App zeigt nur, ob ein Token gesetzt ist und wann er abläuft.

Welche Adressen sind als Endpunkt erlaubt?

Nur öffentlich erreichbare https://-Adressen. Interne Ziele wie localhost, private Netze oder Cloud-Metadaten werden abgelehnt — das schützt vor Missbrauch der Schnittstelle.

Warum kann ich eine freigegebene Schnittstelle nicht mehr ändern?

Freigegebene Schnittstellen sind bewusst unveränderlich — so kann nach der Freigabe niemand mehr Zieladresse oder Token austauschen. Für Änderungen legst du eine neue Version an.

Elementy niestandardowe: API

Interfejs API to formularz, którego wypełnione wartości Skava wysyła jako JSON na adres, który podajesz (twoje zaplecze). W ten sposób możesz bezpiecznie połączyć Skavę z własnymi systemami.

Interfejsami API zarządzasz w Aplikacji webowej w sekcji Elementy niestandardowe → przełącznik Interfejsy API. Tworzenie i edycja są zarezerwowane dla administratorów firmy; wydane interfejsy mogą być następnie uruchamiane przez wszystkich członków firmy.

Skonfiguruj interfejs API

Interfejs składa się z pól wejściowych (tworzą one JSON), adresu docelowego i uwierzytelniania.

Utwórz pola: Każde pole otrzymuje klucz JSON. Po prawej stronie widzisz podgląd JSON na żywo, który jest wysyłany do twojego zaplecza dokładnie w ten sposób.
Adres (URL): adres https:// twojego zaplecza. Dozwolone są tylko adresy HTTPS i publicznie dostępne (zobacz Bezpieczeństwo poniżej).
Metoda: POST (domyślnie), PUT, PATCH lub GET. Z GET wartości są dołączane jako parametry zapytania zamiast być wysyłane w treści.
Uwierzytelnianie: Ustaw nazwę nagłówka (np. Authorization) i prefiks wartości (np. Bearer ), następnie zapisz token. Opcjonalnie ustaw datę wygaśnięcia.
Pola odpowiedzi (opcjonalnie): Zdefiniuj, według ścieżki, które wartości z odpowiedzi zaplecza powinny być wyświetlane — np. order.id lub items[0].sku.
Sprawdź za pomocą Ping i Żądanie testowe, następnie Wydaj.

Przechowuj token bezpiecznie

Token jest przechowywany zaszyfrowany i nigdy nie jest zwracany do klientów — aplikacja tylko pokazuje czy token jest ustawiony i kiedy wygasa. Podczas wysyłania Skava dołącza go po stronie serwera do skonfigurowanego nagłówka. Jeśli ustawisz datę wygaśnięcia, Skava odmawiać wezwania po wygaśnięciu i prosi o odnowienie tokena.

Testowanie: Ping i żądanie testowe

Ping — lekka kontrola osiągalności. Tylko sprawdza czy twój adres odpowiada i nie wysyła tokena ani danych formularza w procesie. Pokazuje osiągalność, status i czas odpowiedzi. Idealne jako pierwszy krok.
Żądanie testowe — prawdziwy przebieg testowy: wysyła przykładowe dane razem z tokenem na twój adres i pokazuje całą odpowiedź oraz wyodrębnione pola odpowiedzi.

Jako administrator możesz uruchamiać oba wciąż w trybie roboczym, aby zweryfikować integrację przed wydaniem.

Szkic i wydanie

Każdy interfejs zaczyna się jako szkic i może być swobodnie edytowany. Gdy wszystko będzie gotowe, wydaj go za pomocą Wydaj.

Wydane interfejsy są niezmienne. To jest celowe: aby po wydaniu nikt nie mógł potajemnie zmienić adresu docelowego lub tokena. Jeśli chcesz coś zmienić, utwórz nową wersję.

Bezpieczeństwo

Aby zapobiec nadużyciu interfejsu, obowiązują ścisłe zasady: dozwolone są tylko adresy HTTPS, a adres musi wskazywać na publiczny adres docelowy — adresy wewnętrzne (np. localhost, sieci prywatne lub metadane chmury) są odrzucane. Skava sprawdza to przy każdym wezwaniu, łączy się dokładnie ze zweryfikowanym adresem, nie podąża za przekierowaniami i ogranicza limit czasu i rozmiar odpowiedzi.

Powiązane

Czy zamiast tego chcesz zbudować wypełnialny szablon dokumentu? Zobacz Elementy niestandardowe: Dokumenty.

Często zadawane pytania

Co to jest interfejs API w Skava?

Formularz, którego wypełnione wartości Skava wysyła jako JSON na adres, który podajesz (twoje zaplecze) — przydatny do łączenia Skava z własnymi systemami.

Kto może tworzyć i uruchamiać interfejsy API?

Tworzenie i edycja są zarezerwowane dla administratorów firmy. Wydany interfejs mogą następnie uruchamiać wszyscy członkowie firmy.

Jaka jest różnica między "Ping" a "Żądaniem testowym"?

Ping tylko sprawdza, czy adres jest dostępny — bez tokena i bez danych. Żądanie testowe wysyła przykładowe dane razem z tokenem i pokazuje całą odpowiedź.

Czy mój token API jest bezpieczny?

Tak. Token jest przechowywany zaszyfrowany i nigdy nie jest dostarczany do klientów. Aplikacja tylko pokazuje, czy token jest ustawiony i kiedy wygasa.

Które adresy są dozwolone jako punkty końcowe?

Tylko publicznie dostępne adresy https://. Cele wewnętrzne, takie jak localhost, sieci prywatne lub metadane chmury, są odrzucane — to chroni przed nadużyciem interfejsu.

Dlaczego nie mogę już zmienić wydanego interfejsu?

Wydane interfejsy są celowo niezmienne — aby po wydaniu nikt nie mógł zamienić adresu docelowego lub tokena. Na zmiany tworzysz nową wersję.