Dokumentacja

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

Notyfikowanie statusu do sklepu

Notyfikowanie statusu kredytu dla sklepu polega na wysłaniu odpowiedniego żądania z dokumentem JSON na adres wskazany przez pole notifyUrl zawarte w treści żądania JSON wysyłanego w czasie tworzenia nowego wniosku. Jest to adres pod który powinno zostać wysyłana żądanie aktualizacji statusu (notyfikacja statusu). Statusy wysyłane są asynchronicznie metodą PUT. Po wysłaniu notyfikacji Comfino oczekuje statusu odpowiedzi 200 OK. W przypadku zwrócenia innego statusu, żądanie jest ponawiane aż do momentu zwrócenia 200 OK. Mogą zdarzyć się przypadki, że Comfino wyśle kilka żądań. W tym przypadku na każde żądanie powinien być zwrócony w odpowiedzi status 200 OK.

Po odbiorze notyfikacji przychodzącej z serwera Comfino, należy poddać weryfikacji wartość sygnatury znajdującą się w nagłówku CR-Signature. Sprawdzanie podpisu powiadomień ma na celu zapewnić zaufaną komunikację pomiędzy sklepem, a Comfino.

Kroki jakie należy wykonać, aby sprawdzić podpis:

  • Do api-key powinna zostać dołączona treść żądania JSON, która została odebrana.
  • Generujemy hash funkcją sha3-256 z powyższego łańcucha tekstowego.
  • Jeśli hash jest równy wartości w CR-Signature, to żądanie jest prawidłowe.

Struktura przekazanego dokumentu JSON:

{
    "status": "CREATED",
    "externalId": "{twój_identyfikator_zamówienia:string}",
    "changedAt": {znacznik czasu informujący kiedy nastąpiła zmiana statusu:int},
    "_links": {
        "self": {
            "href": "http://{HOST_API}/v1/orders/{twój_identyfikator_zamówienia}",
            "method": "GET"
        },
        "cancel": {
            "href": "http:/{HOST_API}/v1/orders/{twój_identyfikator_zamówienia}/cancel",
            "method": "PUT"
        }
    }
}

Budowa nagłówka CR-Signature:

sha3-256(api-key + json-request-body)

Lista możliwych statusów:

Statusy wniosku