Przejdź do głównej zawartości

Akceptowanie regulaminów

Zawarte metody pozwalają na wygenerowanie pola checkbox do akceptacji regulaminu. Wyświetlany jest odpowiedni link do regulaminu.

Tworzenie instancji PayuRegulationsForm z shopId i extCustomerId
PayuRegulationsForm(params, options?)
Ta metoda wymaga publicznego identyfikatora sklepu i unikalnego identyfikatora submerchanta.
Parametery metody
paramsrequiredobject
Parametry formularza akceptacji regulaminów.
shopIdstring
Publiczny identyfikator sklepu z panelu PayU, wymagany.
extCustomerIdstring
Unikalny identyfikator submerchanta nadawany przez marketplace, wymagany.
optionsoptionalobject
Opcje instancji.
devboolean
Umożliwia utworzenie instancji w trybie deweloperskim, co pozwala na działanie w witrynie która nie używa HTTPS.
Zwraca
Instancję PayuRegulationsForm.
Wyjątki
invalid.params
Występuje podczas tworzenia instancji PayuRegulationsForm gdy parametry shopId i extCustomerId nie są określone lub są puste.
npn.https.integration
Występuje podczas tworzenia instancji MarketplaceVerification, gdy protokołem strony, na której wczytywane jest JS SDK nie jest https i file, a strona nie jest ładowana z localhost: 127.0.0.1 lub 0.0.0.0.
Podczas procesu wdrażania można włączyć tryb deweloperski za pomocą parametru options.
const regulationsForm =  PayuRegulationsForm({shopId: 'marketplace-shop-id', extCustomerId: 'ext-customer-id'});
Tworzenie instancji PayuRegulationsForm z parametrem verificationId
PayuRegulationsForm(params, options?)
Ta metoda wymaga identyfikatora weryfikacji, który możesz otrzymać poprzez rejestrację submerchanta przez API.
Parametry metody
paramsrequiredobject
Parametry formularza regulaminu.
verificationIdstring
Identyfikator weryfikacji, wymagany.
optionsoptionalobject
Opcje instancji.
devboolean
Umożliwia utworzenie instancji w trybie deweloperskim, co pozwala na działanie w witrynie która nie używa HTTPS.
Zwraca
Instancję PayuRegulationsForm.
Wyjątki
invalid.params
Występuje podczas tworzenia instancji PayuRegulationsForm gdy parametr verificationId nie jest określony lub jest pusty.
non.http.integration
Występuje podczas tworzenia instancji MarketplaceVerification, gdy protokołem strony, na której wczytywane jest JS SDK nie jest https i file, a strona nie jest ładowana z localhost: 127.0.0.1 lub 0.0.0.0.
Podczas procesu wdrażania można włączyć tryb deweloperski za pomocą parametru options.
const regulationsForm = PayuRegulationsForm({verificationId: 'VERIFICATION_ID'});

Przykłady​

Metody​

Metody Akceptowania Regulaminów
render(selector, options?)
Wyświetla formularz na stronie.
Parametery metody
selectorrequiredstring
Wyszukiwanie elementu odbywa się za pomocą metody querySelectorAll.
optionsoptionalobject
Opcje formularza.
labelstring
Tekst wyświetlany jako etykieta pola checkbox przed linkiem do regulaminu.
linkLabelstring
Tekst wyświetlany jako link do regulaminu. Jeśli ten parametr nie zostanie określony, zostanie wyświetlony link.
styleobject
Stworzony przez ciebie styl formularza.
Wyjątki
element.selector.empty
Parametr selector nie został określony lub jest pusty.
element.selector.not.string
Parametr selector nie jest typu string.
element.not.exists
Element nie istnieje na stronie.
element.too.many.exists
Istnieje więcej niż jeden element na stronie.
element.not.valid
Nieprawidłowy element (metoda appendChild nie została zaimplementowana lub jest elementem typu input).
element.contains.children
Element posiada dzieci.
regulationsForm.render('#regulationsForm', {
    label: 'Accept ',
    linkLabel: 'Terms and Conditions'
});
acceptRegulations()
Wysłanie żądania akceptacji regulaminu.
Wyjątki
regulationsForm.not.rendered
Formularz nie został wyświetlony. Wyświetl formularz za pomocą metody regulationsForm.
regulationsForm.acceptRegulations();
on(event, callback)
Dodanie własnego wywołania zwrotnego (callback) do zdarzenia wywołanego przez Secure Form.
Parametry metody
eventrequiredstring
Typ zdarzenia
Możliwe Wartości
ready Emitowane podczas wyświetlania formularza.
acceptEmitowane po zaakceptowaniu regulaminów na Secure Form.
callbackrequiredfunction
callback po emisji zdarzenia.
Wyjątki
event.unknown
Nie znany typ zdarzenia w parametrze event.
event.callback.not.function
Parametr callback nie jest funkcją.
documentForm
    .on('ready', function() {
        // formularz gotowy
    });

documentForm
    .on('accept', function(body) {
        // zaakceptowano regulaminy
    });

Style formularza​

Styl formularza zależy od tego jak ustwiony jest obiekt style.

Obiket style
Obiekt style grupuje style dla różnych zachowań formularzy w obiektach. Każda grupa ma swoje dozwolone style.
{
    style: {
        label: { 
            fontColor: '#ff0000', 
            fontSize: '20px',
            fontFamily: 'Verdana',
            fontWeight: 'bolder'
        },
        link: {
            fontColor: '#888888',
            fontWeight: '200',
            textDecoration: 'none'
        },
        linkHover: {
            fontColor: '#00ff00',
            fontWeight: '700',
            textDecoration: 'underline'
        }
    }
}
Grupy stylów
Grupa stylówDozwolone styleOpis
label
fontColor fontSize fontFamily fontWeight
Style etykiet.
link
fontColor fontWeight textDecoration
Style odnośników.
linkHover
fontColor fontWeight textDecoration
Styl odnośników po najechaniu kursorem.
Dostępne style
StylOpisDozwolone wartości
fontColor
kolor czcionki
#[0-9a-f]{6}
fontSize
rozmiar czcionki
(\d+|\d*\.\d+)(px|em|%)
fontFamily
rodzina czcionki
[0-9a-z\-\s]{1,50}
fontWeight
grubość czcionki
([1-9]00|normal|bold|lighter|bolder|inherit|initial|unset)
textDecoration
dekoracja tekstu
(none|underline)

Zdarzenia​

Formularze emitują zdarzenia, do których można dołączyć własny callback za pomocą metody on.

Zdarzenie ready
Zdarzenie to jest emitowane po wywołaniu metody render, po wyświetleniu formularza.
Zdarzenie accept
Zdarzenie to jest emitowane gdy regulaminy zostaną zaakceptowane. Callback jest wywoływany z jednym obiektem o następującej strukturze:
PoleOpis
status
Status akceptacji:
  • SUCCESS - akceptacja regulaminów została zakończona pomyślnie,
  • Error - wystąpił błąd podczas akceptacji regulaminów. Informacje o błędzie możesz znaleźć w polu error.
error
Występuje jedynie przy statusie ERROR. Obiekt ten posiada tablicę messages, w której zawarto szczegóły błędu. Więcej informacji znajdziesz w sekcji Błędy.
correlationId
Występuje jedynie przy statusie ERROR.

Błędy​

Obiekt error zawiera tablicę obiektów (messages), w której znajdziesz szczegóły błędów.

Obiekt messages
Parametry obiektu error
PoleOpis
code
Kod błędu.
message
Opis błędu w języku angielskim.
parameters
Obiekt zawierający zmienne fragmenty błędu.
Możliwe kody błędów
PolePowiązane zdarzenieOpis
regulations-not-checked
accept
Checkbox nie został zaznaczony. Zaznaczenie pola checkbox jest wymagane do zaakceptowania regulaminu.
error.regulations.acceptance
accept
Wystąpił błąd podczas przetwarzania akceptacji.
error.network
accept
Wystąpił błąd komunikacji sieciowej. Informacje o przyczynie błędu można znaleźć w obiekcie parameters w polu error.
Przykład obiektu typu event
{
    "status": "ERROR",
    "correlationId": "correlation-id",
    "error": {
        "messages": [
            {
                "code": "regulations-not-checked",
            }
        ]
    }
}

Na tej stronie