Әзірлеуші шолуы

Әзірлеуші беті теңшелетін интеграциялар жасауға арналған Shifton-ның API құжаттамасы мен әзірлеуші құралдарына қатынасты қамтамасыз етеді.

Бұл не?

Әзірлеуші беті — Shifton-мен техникалық интеграциялардың бастапқы нүктесі. Ол үш қойындыдан тұрады: Шолу, Webhooks және Қосымшалар. Шолу қойындысы теңшелетін интеграциялар жасауға, жұмыс процестерін автоматтандыруға немесе Shifton-ды ішкі құралдарыңызбен қосуға пайдалана алатын ағымдағы және ескі API құжаттамасына жылдам сілтемелер береді.

Алғышарттар

Талап	Мәліметтер
Рөл	Owner немесе
Білім	API мен веб-әзірлеуге негізгі түсінік (немесе осыны білетін әзірлеушіге қатынас)

Қадамдық нұсқаулар

Әзірлеуші бетіне кіру

Сол жақ бүйірлік тақтадан Интеграциялар батырмасын басыңыз.

Әзірлеуші

бетіне өтіңіз.

Жоғарғы жағында үш қойынды көресіз: Шолу, Вебхуктар және Қосымшалар.

Шолу қойындысын пайдалану

Шолу қойындысы Shifton-ның API құжаттамасына сілтемелерді көрсетеді:

Сілтеме	Сипаттама
Жаңа құжаттама	Ағымдағы, жаңартылған API құжаттамасына сілтейді
Ескі құжаттама	Ескі интеграциялар үшін мұрагерлік API құжаттамасына сілтейді

Ағымдағы API анықтамасын жаңа қойындыда ашу үшін Жаңа құжаттама батырмасын басыңыз.

Егер ескі API-де жасалған интеграцияңыз болса, мұрагерлік анықтамаға қатынас үшін Ескі құжаттама батырмасын басыңыз.

Басқа Әзірлеуші қойындыларына өту

Әзірлеуші бетінен сонымен қатар мынаға қатынаса аласыз:

Вебхуктар

қойындысы — Shifton-нан нақты уақытты оқиға хабарламаларын алу үшін webhook соңғы нүктелерін орнатыңыз.

Қосымшалар

қойындысы — Shifton-мен интеграцияланатын теңшелетін қосымшаларды жасаңыз және басқарыңыз.

Олар туралы толығырақ мәліметтер жеке мақалаларда берілген.

Қатынас рұқсаттары

Рөл	Әзірлеуші бетін қарау	API құжаттамасына қатынас	Webhooks/Қосымшалар жасау
Owner	Иә	Иә	Иә
	Иә	Иә	Иә
Manager	Жоқ	Жоқ	Жоқ
Қызметкер	Жоқ	Жоқ	Жоқ

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

С: Әзірлеуші бетін пайдалану үшін бағдарламалау дағдылары қажет пе?
Ж: API құжаттамасы әзірлеушілерге арналған. Техникалық емес менеджер болсаңыз, құжаттама сілтемелерін әзірлеу командасымен немесе IT бөліміңізбен бөлісе аласыз.

С: Қандай API құжаттамасын пайдалануым керек — жаңа ма, ескі ме?
Ж: Барлық жаңа интеграциялар үшін Жаңа құжаттамані пайдаланыңыз. Ескі құжаттама мұрагерлік API-де жасалған бар интеграциялармен кері үйлесімділік үшін берілген.

С: API-де сұраулар шегі бар ма?
Ж: Иә, API сұраулар шектеулері қолданылуы мүмкін. Сұраулар шектеулері мен ең жақсы практикалар туралы нақты мәліметтер үшін API құжаттамасын қараңыз.

С: Тірі деректерге әсер етпей API шақыруларын тексере аламын ба?
Ж: Сынау ортасы немесе «sandbox» режимдері туралы ақпарат алу үшін API құжаттамасын қараңыз (қолжетімді болса).

Мүмкін мәселелер мен шешімдер

Мәселе	Мүмкін себеп	Шешім
Бүйірлік тақтада Әзірлеуші беті көрінбейді	Owner немесе рөлі жоқ	Тиісті рөл беруін аккаунт Owner-ынан сұраңыз
Құжаттама сілтемесі қате бетке апарады	Уақытша қызмет мәселесі	Кейінірек қайталап көріңіз немесе Shifton қолдауына хабарласыңыз
Қандай API нұсқасын пайдалану керектігін білмеймін	Бар интеграциямен жұмыс жасауда	Қандай нұсқаны пайдаланатынын анықтау үшін интеграция кодыңыздағы API соңғы нүктесінің URL-дерін тексеріңіз
API кілті көрінбейді	Кілтті алдымен жасау қажет болуы мүмкін	API кілтін жасау үшін API құжаттамасындағы нұсқауларды орындаңыз