NavyFlamePomocSpis treści

Publiczne API: adres firmy i przykłady dostępnych operacji

Do żądań API użyj adresu właściwej firmy, wersjonowanej ścieżki i klucza z potrzebnym zakresem.

Gdzie w paneluPanel firmy > Konto > API
  • Zaloguj się do panelu właściwej firmy.
  • Masz uprawnienie do ustawień API i przygotowane środowisko TEST.

Przykład

Aplikacja TEST pobiera listę produktów z testowej firmy. Nie pokazuj prawdziwego tokenu w przykładzie.

  1. 01

    Sprawdź adres

    Otwórz panel swojej firmy i skopiuj jej domenę. Nie wysyłaj żądań do domeny innej firmy.

    Po tym kroku: Znasz host API.

  2. 02

    Przeczytaj dostępne operacje

    W Konto, API otwórz dokumentację lub listę operacji udostępnionych dla kluczy. Sprawdź wersję ścieżki.

    Po tym kroku: Wiesz, czy potrzebny jest odczyt czy zapis.

  3. 03

    Wykonaj odczyt

    Wyślij jedno żądanie tylko do odczytu na danych TEST. Dodaj wymagany nagłówek autoryzacji zgodnie z dokumentacją API.

    Po tym kroku: Otrzymujesz odpowiedź i kod stanu.

  4. 04

    Sprawdź błąd

    Przy 401 porównaj klucz, przy 403 jego zakres, a przy 404 adres firmy i ścieżkę. Zapisz identyfikator żądania, jeśli jest w odpowiedzi.

    Po tym kroku: Masz konkretną przyczynę do poprawy.

Sprawdź wynik

Jedno żądanie odczytu zwraca dane z właściwej firmy.

Schemat TEST: trzy pierwsze czynności i wynik do sprawdzenia. To nie jest zrzut panelu.Widok poglądowy. Wszystkie wartości są testowe.

Jeśli nie widzisz wyniku

Nie kopiuj przykładów z innej wersji API. Sprawdź aktualny kontrakt widoczny w panelu lub dokumentacji.

Ważne

Zakres publicznego API zależy od uprawnień klucza i włączonych modułów.

Potrzebujesz pomocy? Otwórz Wsparcie w panelu swojej firmy i opisz, na którym kroku pojawił się problem.

Jak zgłosić problem
Schemat TEST: trzy pierwsze czynności i wynik do sprawdzenia. To nie jest zrzut panelu.

Schemat TEST: trzy pierwsze czynności i wynik do sprawdzenia. To nie jest zrzut panelu.

Szukaj po nazwie, kroku lub module. Użyj strzałek i Enter.