API және платформа оқиғалары

Қызметкер интерфейсте істейтіннің бәрі API арқылы қолжетімді. Серіктес арналары, қарыз алушы сайты және ішкі сервистер сол келісімшарттармен жұмыс істейді.

Қол жеткізу және тақырыптар

Сұрату нақты ұйымға және нақты локальға бағытталады. Кілт қол жеткізу аймақтарымен беріледі, жұмысты тоқтатпай қайта шығарылады және кері қайтарылып алынуы мүмкін.

API құжаттамасы

Organization-Id: Ұйымды анықтайды. Жалдаушыға бөлек дерекқор режимінде ол бойынша қосылым таңдалады.
Language-Code: Жауап локалі: анықтамалықтар, мәртебе атаулары және құжат мәтіндері осы тілде қайтарылады.
X-Api-Key: Серіктес интеграциясының кілті. Қол жеткізу аймағы қолжетімді әдістер жиынын шектейді.
Idempotency-Key: Ақша операцияларына арналған қайталау кілті: қайта жіберу екінші транзакция жасамайды.

API бөлімдері

Әдістер пәндік салалар бойынша топталған және платформа құрылымын қайталайды.

Өтінімдер

Өтінім жасау, тексеру қадамдары, құжаттар және андеррайтинг шешімдері.

/applications

Клиенттер

Бейін, сәйкестендіргіштер, құжаттар, келісімдер және банк деректемелері.

/customers

Шарттар

Төлем кестесі, есептеулер, төлемдер және борыш құрамдастары бойынша бөлу.

/loans

Скоринг

Модельдер, ережелер, белгілер және әсер еткен факторлар тізбесі бар нәтижелер.

/scoring

Комплаенс және AML

Тізілімдер бойынша тексерулер, ескертулер, тәуекел бейіндері және реттеушіге хабарламалар.

/compliance, /aml

Өндіріп алу

Істер, байланыстар, төлеу уәделері, сот жұмысы және цессия топтамалары.

/collection

Қорландыру

Инвесторлар, тарту шарттары, облигациялық сериялар және төлемдер.

/funding

Есептілік

Нысан үлгілері, жобалар, тексеру және қажетті форматта жүктеу.

/reporting, /tax-reporting

Клиент кабинеті

Қарыз алушының сайты мен қосымшасына арналған жария әдістер.

/public/customer

Оқиғалар және вебхуктар

Шарт бойынша өзгерістер шығыс кезек арқылы сыртқа жарияланады. Жеткізу өспелі аралықпен қайталаулармен кепілдендіріледі, ал жеткізілмеген хабарламалар жоғалмай бөлек кезекке түседі.

Оқиғаларға жазылым
Тағайындау мекенжайы, оқиғалар жиыны және қолтаңба құпиясы ұйым үшін бапталады.
Жеткізу журналы
Әр әрекет бойынша жауап коды, денесі және келесі қайталау уақыты көрінеді.
Бюроларға оқиғалар
Шарт пен кредиттік желінің отыз үш оқиға түрі кредиттік бюроларға жіберіледі.
Бухгалтерияға оқиғалар
Отыз үш оқиға түрі есеп жүйесіне HTTP немесе файл алмасу арқылы жіберіледі.

Орта және шектеулер

Нақты қосылуға дейін сыртқы провайдерлер бөгеу режимінде жұмыс істейді: жүйе толық жауап береді, бірақ ақша қозғалмайды және нақты тексерулер орындалмайды.

Сыртқы сервистерге әрбір жүгіну сұрау мен жауаптың мазмұнымен бірге журналға жазылады, ал API кілттері тек хеш түрінде сақталады.

Сұрау мысалы

GET /Applications/GetApplications?Offset=0&Count=20
Organization-Id: 42
Language-Code: ru
X-Api-Key: ••••••••

API құжаттамасы Материалдар мен нұсқаулықтар

Жауап форматы: Біртұтас қабықшадағы JSON: код, сәттілік белгісі, қате мәтіні және пайдалы жүктеме.
Беттеп таңдау: Серверлік. Ығысу мен саны сұратуда беріледі, жауапта жазбалардың жалпы саны болады.
Идемпоттылық: Ақша операциялары мен кестені өзгертулер үшін міндетті.
Локализация: Алты тіл. Локаль ұйым баптауымен емес, сұрату тақырыбымен анықталады.
Сынақ стенді: Сол келісімшарттары және провайдерлердің орнына бөгеулері бар бөлек контур.
Нұсқалау: Үйлеспейтін өзгерістер бөлек нұсқамен шығады, ескісі сүйемелдеу шарты бойынша жұмысын жалғастырады.

Жиі қойылатын сұрақтар

Интерфейссіз тек API арқылы жұмыс істеуге бола ма

Иә. Қызметкер интерфейсі сол API-ды пайдаланады, сондықтан интерфейсте қолжетімді сценарий кілттің қол жеткізу аймағы шегінде сыртқы клиентке де қолжетімді.

Серіктес аутентификациясы қалай құрылған

Серіктес шектеулі қол жеткізу аймағы бар кілт алады. Кілт хеш түрінде сақталады, тоқтаусыз қайта шығарылады, ал барлық шақырулар сұрату мен жауап денесімен сыртқы өтініштер журналына түседі.

Төлемді қайта жібергенде не болады

Ақша операциялары қайталау кілтін қабылдайды. Сол кілтпен қайталанған сұрату бірінші операцияның нәтижесін қайтарады және екінші транзакция жасамайды.

Мерзімі өту немесе өтеу туралы хабарламаны қалай алуға болады

Оқиғаларға жазылым арқылы. Тағайындау мекенжайы, оқиғалар жиыны және қолтаңба құпиясы көрсетіледі. Әр жеткізу әрекеті тіркеледі, сәтсіздері өспелі аралықпен қайталанады.