API integracji wtyczek
Kontrakt REST i webhook dla wtyczek e-commerce (Saleor, Shoper, PrestaShop, Shopify, partnerzy) do przesyłania zleceń generowania i odbierania wyników.
API integracji wtyczek to kontrakt REST + webhook, którego wtyczki e-commerce używają do przesyłania zleceń generowania w workspace Qamera AI sprzedawcy i odbierania wyników asynchronicznie przez webhooki.
Szybkie linki
- Kontrakt OpenAPI 3.1 (YAML) — wklej do Swagger UI, Stoplight lub ulubionego generatora kodu.
- Uwierzytelnianie — klucze API, scope, limity zapytań.
- Endpointy — każda trasa, request, response.
- Protokół webhook — kształt payloadu, podpisywanie, ponowienia.
- Przykłady curl — gotowe do skopiowania happy paths dla każdego endpointu.
- Subprocesory — lista podmiotów trzecich, które mogą otrzymywać dane sprzedawcy.
- Lista błędów — każdy kod, status HTTP, retryable, sposób naprawy.
Wersjonowanie
Wersja główna jest zakodowana w URL (/api/v1/plugin/...). Zmiany addytywne (nowe pola, nowe kody błędów) wchodzą bez zmiany wersji i są ogłaszane w changelogu. Zmiany łamiące kontrakt wchodzą pod /api/v2/....
Uwierzytelnianie
Format klucza API, scope, idempotencja i ograniczenie szybkości w API integracji wtyczek.
Endpointy
Każda trasa w API integracji wtyczek v1 — kształt request, kształt response, scope.
Protokół webhook
Kształt payloadu, podpisywanie HMAC, polityka ponowień i wyłącznik bezpieczeństwa dla webhooków wychodzących.
Przykłady curl
Gotowe do skopiowania wywołania curl dla każdego endpointu API integracji wtyczek — happy path i typowe błędy.
Subprocesory
Procesory danych podmiotów trzecich, które mogą otrzymywać dane sprzedawcy przez API integracji wtyczek, z ujawnieniem zgodnym z GDPR Art. 28(2).