Przejdź do treści
ShopentlyLearn

Uprawnienia i plany API

Dostęp wymaga odpowiedniego planu sklepu oraz skutecznych uprawnień klucza.

Co sprawdzić przed wywołaniem API

  1. Uwierzytelnianie

    Sprawdź uwierzytelnienie.

  2. Dostępne od planu

    Sprawdź, czy plan sklepu udostępnia potrzebną funkcję API.

  3. Wymagane uprawnienia

    Sprawdź uprawnienia klucza oraz warunki dotyczące przesyłanych pól.

Który plan jest potrzebny

Który plan jest potrzebny
Dostępne od planuOpis
BASICBASIC obejmuje odczyt zamówień i zgłoszeń, zmianę ich statusów, zmianę statusu płatności zamówienia oraz zapisanej kwoty zwrotu.
STANDARDOperacje katalogu, CMS, wyszukiwania i magazynu wymagają planu STANDARD lub wyższego.

Sklepy z wcześniej wykupionym planem otrzymują funkcje API przewidziane dla tego planu.

Uprawnienia do konkretnej operacji

  • Dokumentacja podaje required_scopes każdej operacji oraz conditional_scopes dla dodatkowo chronionych pól lub zmian.
  • Odczyt zasobu nie przyznaje prawa do jego tworzenia, edycji ani usuwania.
  • Pobranie tokenu i kontekstu nadal wymaga uwierzytelnienia, nawet gdy nie wskazano uprawnienia do zasobu.

Pobierz listę

GET/api/v1/products
Uwierzytelnianie
Bearer
Dostępne od planu
STANDARD
Wymagane uprawnienia
catalog.product:read

Zmień

PATCH/api/v1/products/{product_id}
Uwierzytelnianie
Bearer
Dostępne od planu
STANDARD
Wymagane uprawnienia
catalog.product:update

Kiedy potrzebne są dodatkowe uprawnienia

Zmień

PATCH/api/v1/products/{product_id}
Uwierzytelnianie
Bearer
Dostępne od planu
STANDARD
Wymagane uprawnienia
catalog.product:update
Dodatkowe uprawnienia dla wybranych pól
  • Gdy przesyłasz pole variant_value_ids: catalog.product_variant:create, catalog.product_variant:update, catalog.product_variant:delete
  • Gdy przesyłasz pole variants_enabled: catalog.product_variant:update

Co się dzieje po zmianie planu

Jeżeli obniżenie planu odbiera uprawnienie, jest ono usuwane z kluczy API oraz odznaczane i wyszarzane w panelu.