API токені

API токені үшінші тарап бағдарламасына Omniscol-дың API нүктелерін мектеп атынан оқу режимінде, ал жазу API нүктелері таңдалса, жазу режимінде де шақыруға мүмкіндік береді.

Бұл қуатты құрал — сондықтан сақтықпен қолданыңыз.

Жасау

Токен Бөлісу бөлімінде жасалады (Импорт/Экспорт > Бөлісу). Сіз мыналарды көрсетесіз:

• бір кілт (Omniscol-да жасалады, атауы және қажет болса мерзімі бар; мерзімін кейін өзгертуге болады),
• бір қолданылу аясы: бұл токен шақыра алатын API нүктелерінің тізімі (тек қатаң қажеттісін ғана беріңіз),
• қаласаңыз, токеннің мерзімі. Бұл күн жасалған JWT-ге жазылады және кейін өзгертілмейді.

Кілтті жою немесе оның мерзімі аяқталуы одан шығарылған токендерді дереу қайтарып алады. Жеке токеннің мерзімін өзгерту үшін жаңа JWT жасаңыз.

Қолдану

Токен Authorization: Bearer <token> HTTP тақырыбында беріледі, немесе (жұмыстағы жүйе үшін аз ұсынылады) URL-де ?auth=<token> арқылы.

Ұсынылатын тәжірибе

• Әр интеграцияға бір кілт — бөлек қайтарып алуды жеңілдетеді.
• Ең аз қолданылу аясы — әдепкі бойынша бәрін емес, тек қажетті API-ды белгілеңіз.
• Мерзімді дұрыс деңгейде беру — интеграцияны ұзақ мерзімге басқару үшін кілттің мерзімін пайдаланыңыз; өзгертілмейтін уақытша қол жеткізу үшін токеннің мерзімін пайдаланыңыз.
• Жүйелі жаңарту — кілтті 6–12 айда бір рет қайта жасаңыз.
• Git-те сақтамаңыз — токен ашық репозиторийде нұсқаланып қалмауы тиіс. Серверіңіздің орта айнымалыларын пайдаланыңыз.

OIDC / SSO-дан айырмашылығы

Нақты пайдаланушыларды мекемелік сәйкестендіруі арқылы қосу үшін OIDC / SSO бетінде сипатталған тәсілді пайдаланыңыз. API токені сервер-сервер техникалық интеграцияларына арналған, пайдаланушылардың күнделікті кіруіне емес.