Integracja API

Integracja API generuje klucze i nagłówki potrzebne do połączenia własnej witryny, aplikacji lub narzędzia no-code z Bitee. W jednym miejscu masz adres API, identyfikator firmy, sekrety i dokumentację Swagger.

Opublikowano
Zaktualizowano
Wersja systemu26.39
Czas czytania2 min
Na tej stronieKlucze i nagłówki HTTPStatus i dokumentacjaKanał zamówień API

Partnerskie API pozwala budować własne witryny i aplikacje na danych Bitee: pobierać katalog, wyliczać koszyk, składać zamówienia. Bez edycji plików .env: wszystkie wartości kopiujesz z tego ekranu.

Ekran Integracja API

Klucze i nagłówki HTTP#

Każda wartość ma ikony pokazania, ukrycia i kopiowania, a sekrety dodatkowo odświeżania.

WartośćNagłówekZnaczenie
Adres API(API Base URL)Bazowy adres partnerskiego API Bitee
Identyfikator firmyX-Company-IdIdentyfikator firmy (tenanta), wymagany przy każdym wywołaniu
Sekret wewnętrzny (BFF)X-Internal-SecretUżywaj wyłącznie po stronie serwera (BFF, backend, no-code z serwerem pośredniczącym). Nigdy w kodzie przeglądarki
Sekret kanału zamówieńX-Api-SecretWymagany przy składaniu zamówień z zewnętrznego UI
Identyfikator kanału zamówieńX-Order-TypeMapuje źródło zamówienia na skonfigurowany kanał API

Status i dokumentacja#

Panel Status integracji pokazuje, czy konfiguracja jest Gotowa, oraz identyfikator firmy. Przycisk Uzupełnij brakujące klucze tworzy brakujące sekrety i kanał zamówień API. Panel Dokumentacja API prowadzi do Swagger UI (testowanie endpointów) i ReDoc (czytelna referencja). W Swaggerze użyj przycisku Authorize z nagłówkami wygenerowanymi na tym ekranie.

Sekcja Gotowe snippety pokazuje po wygenerowaniu kluczy gotowe przykłady kodu do wklejenia.

Kanał zamówień API#

Zamówienie złożone przez API musi pochodzić z kanału, który dopuszcza jego źródło. Kanał Sklep internetowy (typ API zewnętrzne) tworzy się razem z kluczami i przyjmuje źródła public_storefront, external_api oraz własny identyfikator. Zob. Kanały zamówień.

PodsumowanieW skrócie

Skopiuj z ekranu adres, identyfikator firmy i sekrety, trzymaj sekrety po stronie serwera i testuj w Swaggerze. Odświeżenie sekretu natychmiast unieważnia stary.