Dokumentacja

Dokumentacja przedstawia krok po kroku jak w prosty i szybki sposób skomunikować
Twój sklep z Comfino.

Rejestracja nowego sklepu - pobieranie zgód

Podczas rejestracji sklepu w Comfino.pl konieczne jest wysłanie ID zaakceptowanych zgód. Informacje o tym, jakie zgody są dostępne, i które z nich są obowiązkowe do wyrażenia, można uzyskać wykonując następujące zapytanie:

Zapytanie:

curl -X GET 'https://{HOST_API}/v1/fetch-agreements'

Przykładowa odpowiedź:

[{
    "id": 1,
    "required": true,
    "content": "Zapoznałem się i akceptuję postanowienia <a href=\"https:\/\/comfino.pl\/regulamin\/\">Regulaminu<\/a>.",
    "additionalContent": null
}, {
    "id": 2,
    "required": true,
    "content": "Wyrażam zgodę na działania marketingowe w związku z prośbą o kontakt.",
    "additionalContent": null
}]

Odpowiedzią jest tablica w formacie JSON której elementy to obiekty reprezentujące kolejne zgody. Pola w obiekcie zgód:

  • id - int - ID zgody (wartość do odesłania do Comfino.pl przy rejestracji sklepu).
  • required - boolean - wartość true/false oznaczająca, czy wyrażenie danej zgody jest wymagane, czy też jest to zgoda dobrowolna.
  • content - string - treść wiodąca zgody.
  • additionalContent - string/null - treść dodatkowa zgody: często występujące w przypadku zgód rozwinięcie treści. Na formularzach wyświetlane najczęściej mniejszym rozmiarem tekstu lub po kliknięciu w dodatkowy przycisk np. "rozwiń". Treść dodatkowa występuje tylko przy niektórych zgodach, pole może mieć zatem wartość null.