A3.Trust ашу

Өнімдер мен интеграцияларға арналған API

A3.Trust шешімдерді басқа жүйелерге жеткізеді: A3.HR, A3.Sales, компанияның кадрлық және сатып алу жүйелеріне. Ашық API мен вебхуктар бірінші релизден жұмыс істейді, ал өнімдегі құмсалғыш кодты оқымай қосылуға көмектеседі.

Қағидаттар

  • Рұқсаттары бар API кілті

    Кілт интеграциялар бөлімінде рұқсаттар жиынымен шығарылады: тексеру құру, тексеруді оқу, мониторинг, субъектілерді оқу, тапсырыстарды тексеру. Кілтті тоқтап қалусыз қайта шығаруға болады.

  • Идемпотенттілік

    Сол Idempotency-Key кілтімен сұрауды қайта жіберу екінші тексеруді құрмайды және оны пакеттен шегермейді. Басқа денесі бар сол кілт қате қайтарады.

  • Жиілікті шектеу

    Минутына сұраулар шегі кілтке белгіленеді. Асып кету түсінікті қате қайтарады, ал сұраулар журналы әр шақыруды көрсетеді.

  • Материалдар емес, шешім

    API шешімді тапсырыс беруші көлемінде береді: түрі, шектеулері, мерзімі. Субъект тек идентификатор бойынша ізделеді, досьені тегі бойынша сұрыптап шығуға болмайды.

Негізгі операциялар

Әдістер ұйымыңыздың сақтау өңіріндегі PublicApi мекенжайы бойынша қолжетімді. Өрістердің толық тізімі API құжаттамасында.

POSTCreateCheckRequest

Тексеру сұрауын құру

GETGetCheckRequestStatus

Сұрау мәртебесі және шешім

GETGetActiveVerdict

Жаңа тексерусіз қолданыстағы шешім

POSTSetSubjectMonitoring

Субъектіні мониторингке қою

DELETERemoveSubjectMonitoring

Субъектіні мониторингтен алу

GETGetSubjectRiskLabels

Субъектінің тәуекел белгілері

GETFindSubject

Субъектіні идентификатор бойынша іздеу

POSTCheckOrderCompliance

Тапсырысты тыйым салынған қызметтер тізілімі бойынша тексеру

Мысал: субъект бойынша қолданыстағы шешім

Тұтынушы жүйелер үшін негізгі сценарий: жаңа тексеру құрмай шешімді алу.

GET /PublicApi/GetActiveVerdict?subjectId=1024
API-KEY: a3t_7c41…
Domain: company
{
  "verdictType": "ApprovedWithRestrictions",
  "riskLevel": "Moderate",
  "restrictions": [
    { "type": "FullPrepayment" },
    { "type": "AmountLimit", "amount": 25000000, "currency": "KZT" }
  ],
  "validUntil": "2027-10-14",
  "reasonForRequester": "Налоговая задолженность погашена, судебные споры в работе"
}

Вебхуктар

Тұтынушы жүйелер API-ге циклмен сұрау жібермейді: оқиғалар өздігінен келеді. Әр шақыруға HMAC-SHA256 қолтаңбасы қойылады, жеткізу журналы алушының жауабын көрсетеді, сәтсіз жеткізуді қайталауға болады.

trust.check.accepted

Сұрау жұмысқа қабылданды

trust.check.rejected

Сұрау себебімен қабылданбады

trust.check.info_requested

Қосымша мәліметтер сұралды

trust.check.completed

Шешім қалыптасты

trust.check.verdict_revoked

Шешім кері қайтарылды немесе қайта қаралды

trust.monitoring.alert

Аса маңызды мониторинг дабылы

Өнімдегі құмсалғыш

Интеграциялар бөлімінде әкімші кілт пен операцияны таңдап, сұраудың дайын мысалын түзетеді және жауап пен curl командасын көреді. Деректерді өзгертетін операциялар жеке растауды талап етеді.

A3.HR-мен контракт

Үміткерлерді тексеру бірден жұмыс істейді: hr.background_check және trust.check оқиғалары өнімдердің API-контракттары деңгейінде келісілген.

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