Dokumentacja

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

Rejestracja nowego sklepu

Poniższe zapytanie pozwala zarejestrować nowy sklep w systemie Comfino.pl. Rejestracja nie oznacza jednak automatycznego uruchomienia usługi płatności. To tylko pierwszy krok - potrzebne jest jeszcze podpisanie umowy i integracja z systemem sklepu. Po rejestracji skontaktuje się z Tobą przedstawiciel Comfino.pl, który 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]
}'

Ciało zapytania to obiekt JSON z następującymi polami:

Nazwa pola Typ Opis
name string nazwa sklepu
webSiteUrl string adres strony internetowej sklepu
contactName string imie lub imie i nazwisko osoby z ktora skontaktujemy sie, aby podjac dalsze kroki
contactEmail string adres e-mail do kontaktu
contactPhone string numer telefonu do kontaktu
platformId int ID platformy sprzedazowej z jakiej korzysta sklep (patrz tabela ponizej)
agreements int[] Tablica wartosci typu integer oznaczajacych wyrazone zgody. Wyrazenie zgod jest konieczne aby zarejestrowac sklep. Aby dowiedziec sie jakie zgody nalezy wyrazic zapoznaj sie z sekcja dokumentacji Rejestracja nowego sklepu - pobieranie zgod

Rejestracja nowego sklepu - pobieranie zgód

Możliwe wartości pola platformId:

Wartosc Opis
1 AtomStore
2 Click Shop
3 Comarch
4 Ebexo
5 E-sklep
6 IAI Shop
7 IdoSell
8 Magento
9 OpenCart
10 osCommerce
11 PrestaShop
12 Quick Cart
13 RedCart
14 Selesto
15 Selly
16 Shoper
17 ShopGold
18 Shopify
19 Shoplo
20 Shopware
21 Sky-Shop
22 SOTE
23 Sylius
24 TakeDrop
25 VirtueMart
26 Wix
27 WooCommerce
28 Zen Cart
29 Inne
30 Dedykowane

Przykładowa odpowiedź w przypadku sukcesu:

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

Powyższa odpowiedź oznacza, że udało się zarejestrować sklep. Oczekuj na kontakt od przedstawiciela Comfino.pl. Wartości apiKey i widgetKey to klucze, które będą potrzebne do integracji systemu płatności - zapisz je. Jeśli jednak je zagubisz, nie martw się, zawsze możesz się z nami skontaktować i odzyskać klucze. Klucz widgetKey jest używany przez widget Comfino osadzany na stronie sprzedawcy.

Przykładowa odpowiedź w przypadku błędu:

{
  "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 zawierający jedno lub więcej pól z wartościami typu string (tekst). Nazwy pól odpowiadają nazwom pól z żądania rejestracji. Wartości pól opisują przyczynę wystąpienia błędu.

Zobacz również: