Dokumentacja

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

Dodanie punktu sprzedaży usług

  • Każdy wpis o danym NIP=ie jest unikalny. Nie można dodać do bazy kilku wpisów o takiej samej wartości NIP-u

Zapytanie: | Zapytanie jest walidowane pod kątem poprawności przesyłanych wartosci

curl -X POST 'http://{HOST_API}/v1/sale-point-add' \
--header 'API-KEY: {API-KEY}' \
--header 'Content-Type: application/json' \
--data-raw '{
  "name": "{nazwa_dostawcy_usługi}",
  "taxId": "{NIP usługodawcy}",
  "city": "{miasto_usługodawcy}",
  "accountNumber": "{numer_konta_usługodawcy}",
  "contactPerson": "{imię_osoby_do_kontaktu}",
}'

Definicja pól:

Nazwa pola Typ Wymagane Akceptowalne wartosci
name string tak Alfanumeryczne znaki do 100
taxId string tak Alfanumeryczne znaki do 10
city string nie Alfanumeryczne znaki do 50
contactPerson string nie Alfanumeryczne znaki do 50
accountNumber string nie Alfanumeryczne znaki do 50

Odpowiedź:

{
    "name": "{nazwa_dostawcy_usługi}",
    "taxId": "{NIP usługodawcy}",
    "active": 1,
    "city": "{miasto_usługodawcy}",
    "accountNumber": "{numer_konta_usługodawcy}",
    "contactPerson": "{imię_osoby_do_kontaktu}",
    "_links": {
        "deactivate": {
            "href": "http://{HOST_API}/v1/sale-point/{NIP usługodawcy}/deactivate",
            "method": "PUT"
        }
        "self": {
            "href": "http://{HOST_API}/v1/sale-point/{NIP usługodawcy}",
            "method": "GET"
        }
    }
}

Kody odpowiedzi:

  • 200 Created
  • 401 Unauthorized
  • 403 Http Forbidden
  • 404 Http Not Found
  • 405 Method Not Allowed
  • 500 Internal Server Error