API

Rejestracja sklepu

Opisuje endpoint rejestrujący nowy sklep w systemie Comfino.pl.

Rejestracja sklepu

Rejestruje nowy sklep w systemie Comfino.pl. Rejestracja nie uruchamia automatycznie usługi płatności — wymaga podpisania umowy i integracji z systemem sklepu. Po rejestracji przedstawiciel Comfino.pl skontaktuje się i wyjaśni kolejne kroki.

Zapytanie

curl -X POST 'https://{HOST_API}/v1/user' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Nazwa sklepu",
    "webSiteUrl": "http://example.com",
    "contactName": "Adam Nowak",
    "contactEmail": "kontakt@example.com",
    "contactPhone": "000000000",
    "platformId": 1,
    "agreements": [1,2]
}'

Definicja pól

PoleTypWymaganeOpis
namestringtakNazwa sklepu
webSiteUrlstringtakAdres strony internetowej sklepu
contactNamestringtakImię lub imię i nazwisko osoby kontaktowej
contactEmailstringtakAdres e-mail do kontaktu
contactPhonestringtakNumer telefonu do kontaktu
platformIdinttakID platformy sprzedazowej (patrz tabela ponizej)
agreementsinttakTablica ID zaakceptowanych zgód — wymagana do rejestracji; lista dostępnych zgód: pobieranie zgód

Możliwe wartości pola platformId:

WartośćPlatforma
1AtomStore
2Click Shop
3Comarch
4Ebexo
5E-sklep
6IAI Shop
7IdoSell
8Magento
9OpenCart
10osCommerce
11PrestaShop
12Quick Cart
13RedCart
14Selesto
15Selly
16Shoper
17ShopGold
18Shopify
19Shoplo
20Shopware
21Sky-Shop
22SOTE
23Sylius
24TakeDrop
25VirtueMart
26Wix
27WooCommerce
28Zen Cart
29Inne
30Dedykowane
31POS
32Sellingo
33CStore
34DIRECT
35Web To Learn
36Berg System
37PayTel
38PeP

Odpowiedź

Odpowiedź przy sukcesie:

{
    "apiKey": "dfe8a410-0834-49b3-be13-e69e34ea1c6e",
    "widgetKey": "f53d8bb2-ec8d-4ba0-9666-bcae6f48f810"
}

Sklep został zarejestrowany — oczekuj kontaktu od przedstawiciela Comfino.pl. Zapisz wartości apiKey i widgetKey; są potrzebne do integracji systemu płatności. W razie utraty kluczy skontaktuj się z Comfino.pl. Klucz widgetKey jest używany przez widget Comfino osadzany na stronie sprzedawcy.

Odpowiedź przy błędzie:

{
  "errors": {
    "name": "This value should not be blank.",
    "webSiteUrl": "The WebsiteUrl http://example.com is already registered.",
    "contactName": "This value should not be blank.",
    "contactEmail": "This value should not be blank.",
    "contactPhone": "Invalid phone number.",
    "platformId": "The platformId 0 does not exists.",
    "agreements": "Invalid agreements."
  }
}

errors to obiekt z jednym lub więcej polami string. Nazwy pól odpowiadają nazwom pól żądania rejestracji, a wartości opisują przyczynę błędu.

Zobacz również: