Przejdź do głównej treści
← Dokumentacja API

Szybki start

Trzy kroki prowadzą sklep od zera do bezpiecznego zamówienia: osadź konfigurator, zweryfikuj wycenę na swoim serwerze przed koszykiem i przyjmij podpisany webhook. Osadzony konfigurator wykonuje za Ciebie wywołania ze strony sklepu; Twój kod zajmuje się tylko stroną serwera.

Bazowy adres URL https://cfg.cutoptim.com · Wersja kontraktu v1 · Dokument OpenAPI 3.1

Wczesny dostęp: API dla sprzedawcy jest gotowe i można je wypróbować w sklepie sandbox; wtyczki do platform sklepowych są jeszcze w przygotowaniu. CutOptim nie pobiera płatności: koszyk, finalizacja zamówienia i płatność zostają w Twoim sklepie.

Ścieżki, nazwy pól, kody błędów, nazwy nagłówków i przykłady kodu pozostają po angielsku: to jest kontrakt.

1. Osadź konfigurator

Dodaj skrypt i element na stronie produktu, z Twoim kluczem publicznym (pk_live_… lub kluczem testowym pk_test_… na czas budowy). Origin strony musi znajdować się wśród dozwolonych originów klucza. Osadzony konfigurator sam wywołuje wtedy GET /cfg/v1/config/public, POST /cfg/v1/preview, POST /cfg/v1/quote i POST /cfg/v1/order.

Gdy kupujący złoży zamówienie, usługa zapisuje podpisane zamówienie, a element wywołuje zdarzenie przeglądarki cutoptim:order z { orderId, order, idempotencyKey }. Traktuj to zdarzenie jako wskazówkę dla swojej strony, nigdy jako dowód ceny.

<script type="module" src="https://cfg.cutoptim.com/embed/assets/cutoptim-configurator.js"></script>

<button data-cutoptim-open="#cut">…</button>
<cutoptim-configurator id="cut" mode="modal" key="pk_live_your_publishable_key" lang="pl">
</cutoptim-configurator>

<script>
  document.getElementById('cut').addEventListener('cutoptim:order', (e) => {
    // e.detail = { orderId, order, idempotencyKey } - send it to YOUR server, which verifies it
  });
</script>

2. Zweryfikuj na serwerze przed koszykiem

Twój serwer wysyła token wyceny na POST /cfg/v1/quote/verify z kluczem tajnym. Odpowiedź to valid oraz redeemed; odmowa to nadal 200 z valid: false i reason. Następnie pobiera zamówienie wskazane przez przeglądarkę przez GET /cfg/v1/orders/{id} i porównuje hash planu, hash wyceny, walutę i sumy z zweryfikowanym tokenem. Dopiero wtedy tworzy pozycję koszyka po zweryfikowanej cenie.

curl -X POST https://cfg.cutoptim.com/cfg/v1/quote/verify \
  -H "Authorization: Bearer $CUTOPTIM_API_SECRET" \
  -H "Content-Type: application/json" \
  -d '{"quoteToken":"<order.quote.quoteToken>"}'
# {"valid":true,"redeemed":true,"claims":{…},"test":false}

curl https://cfg.cutoptim.com/cfg/v1/orders/<orderId> \
  -H "Authorization: Bearer $CUTOPTIM_API_SECRET"
# {"orderId":"…","status":"received","priced":true,"planHash":"…","quoteHash":"…","totals":{…}}

3. Odbierz podpisany webhook

Opublikuj endpoint webhooka w konfiguracji sklepu. Każde zamówienie produkcyjne wysyła order.created, każda zmiana statusu order.status_changed. Odczytaj surową treść, sprawdź nagłówek CutOptim-Signature, a potem zapisz zamówienie raz na CutOptim-Event-Id. Odbiornik poniżej to przykład referencyjny, bez zmian.

// example-server.mjs - a webhook endpoint on node:http, to read and adapt.   CUTOPTIM_WEBHOOK_SIGNING=whsec_... node example-server.mjs
// (whsec_REPLACE_ME is a placeholder: the real secret comes from the CutOptim admin route.)
import { createServer } from 'node:http';
import { createWebhookReceiver } from './cutoptim-verify.mjs';

const secret = process.env.CUTOPTIM_WEBHOOK_SIGNING;
if (!secret) { console.error('set CUTOPTIM_WEBHOOK_SIGNING (whsec_REPLACE_ME is a placeholder)'); process.exit(1); }

const receive = createWebhookReceiver({
  secrets: [secret],
  async onEvent(event) {
    // event.type === 'order.created'; event.data.order is the signed order document. Store it in YOUR order table here,
    // keyed by event.data.orderId, in the same transaction that records the event id as seen.
    console.log('order.created', event.data.orderId);
  },
});

createServer(async (req, res) => {
  if (req.method !== 'POST') { res.writeHead(405).end(); return; }
  const chunks = []; let size = 0;
  for await (const c of req) { size += c.length; if (size > 2_000_000) { res.writeHead(413).end(); return; } chunks.push(c); }
  const out = await receive({ rawBody: Buffer.concat(chunks), headers: req.headers });   // the RAW bytes, not parsed JSON
  res.writeHead(out.status, { 'Content-Type': 'application/json' }).end(JSON.stringify({ result: out.reason }));
}).listen(Number(process.env.PORT ?? 8787));

Dalej

Klucze, klucze testowe i originy: Klucze i uwierzytelnianie. Pełny odbiornik, wersja PHP i harmonogram ponowień: Webhooki. Wersja krok po kroku dla Twojej platformy: Własny sklep lub ERP.

Nie ma tu przycisku „wypróbuj” celowo: klucz tajny należy do Twojego serwera, nigdy do przeglądarki. Sklep demonstracyjny pokazuje osadzenie i przekazanie zamówienia działające od początku do końca.

Informacje prawneWarunki konfiguratora (EN) ·Umowa powierzenia przetwarzania danych (EN) ·Informacja o prywatności dla kupujących ·Licencje stron trzecich (EN)