Серіктестерге арналған ОАұтһ қосымшалар

Партнер-меншігіндегі ОАұтһ қолданбасы бірнеше Планфіх есептік жазбаларын байланыстыратын интеграцияға арналған. Барлық клиенттік есептік жазбалар үшін бірдей қолданба тіркелгі деректері пайдаланылады, алайда әрбір есептік жазба қабылдауды бөлек бақылайды және әрбір пайдаланушы өз атынан қосылуға келісім береді.

Егер интеграция тек бір есептік жазбаға арналған болса, аццоұнт-оунед аппліцатіон жасау оңайырақ.

Қолданбаны құру

Өз партнер есептік жазбаңызды ашыңыз.
ОАұтһ аппліцатіонс бөліміне өтіңіз.
Цреате аппліцатіон таңдаңыз.
Пайдаланушылар мен әкімшілер көретін атау мен сипаттаманы енгізіңіз.
ОАұтһ клиент түрін таңдаңыз.
Редірецт ҰРЫ-ларды қосыңыз.
РЕСТ АПЫ үшін ең аз қажетті рұқсаттарды (сцопес) таңдаңыз.
Қолданбаны сақтап, оның тіркелгі деректерін көшіріп алыңыз.

Жаңа қолданба жеке болып табылады және оған қосылатын әрбір есептік жазбада нақты мақұлдау қажет.

ОАұтһ клиент түрі

Тyпе	Ынтендед аппліцатіонс	Цредентіалс
Пұбліц	Мобильді, десктоп және браузерлік қолданбалар, сонымен қатар жергілікті МЦП клиенттері.	Тек бір `client_id`. Клиенттік құпия жоқ; ПКЦЕ С256 міндетті.
Цонфідентіал	Құпия сервер жағында сақталатын және клиент жағындағы кодта сақталмауы мүмкін қолданбалар.	`client_id` және `client_secret`.

ОАұтһ клиент түрі қолданбаның жарияланған-жарияланбаған болуынан бөлек. Мысалы, жеке мобильді қолданба — құпиясы жоқ пұбліц ОАұтһ клиенті.

Редірецт ҰРЫ-лар

Планфіх пайдаланушыны жүйеге кіруден кейін қайтаруы мүмкін әрбір ҰРЛ-ды көрсетіңіз.

Веб қызмет үшін https қолданыңыз.
http тек localhost және 127.0.0.1 сияқты лоопбацк мекенжайлар үшін рұқсат етіледі.
Лоопбацк мекенжайы үшін клиент динамикалық порт қолдана алады, бірақ схема, хост, жол және сұрау жолы дәл сәйкес болуы тиіс.
Уілдцард-тар, ҰРЛ фрагменттері немесе сіз бақыламайтын редірецт ҰРЫ-ларды қолданбаңыз.

Сцопес

Сцопес қолданбаның максималды рұқсаттарын анықтайды. Тек қана РЕСТ АПЫ сцопе ліст-тен қажетті рұқсаттарды сұраңыз.

Қолданба сцопес-пері пайдаланушының қалыпты рұқсаттарын алмастырмайды. Сцопе берілген жағдайда да қолданба тек сол пайдаланушыға қолжетімді деректермен ғана жұмыс істей алады.

Редірецт ҰРЫ-ларды немесе сцопес-ты өзгерткенде жаңа мақұлдау нұсқасы пайда болады. Бұрын қосылған есептік жазбалар жаңа нұсқаны қарап, мақұлдауы қажет, ал пайдаланушылар қайтадан қосылулары тиіс.

Клиент есептік жазбасын қосу

Жеке партнер-меншігіндегі қолданба әрбір есептік жазбада әкімші тарапынан нақты мақұлдауды талап етеді.

Партнер есептік жазбаңызда қолданбаны ашыңыз.
Аппровал лінк аймағына клиент есептік жазба атауын енгізіңіз.
Генерацияланған сілтемені көшіріп, сол есептік жазбаның әкімшісіне жіберіңіз.
Әкімшіден иесін, редірецт ҰРЫ-ларды және сцопес-ты тексеріп, қолданбаны мақұлдауын сұраңыз.
Мақұлдаудан кейін есептік жазбадағы пайдаланушылар ОАұтһ авторизациясын аяқтай алады. Әр пайдаланушы өз атынан бөлек келісім береді.

Бұл сілтеме Аццоұнт манагемент → АПЫ → ОАұтһ анд МЦП аппліцатіонс бетін ашады және сұралатын қолданбаны көрсетеді.

Қосумен бірге әкімші қолданбаны таңдағанда Аппрове анд цоннецт опциясын таңдай алады.

Жеке және жария қолданбалар

Статұс	Һоу іт іс адміттед то ан аццоұнт
Прівате	Кез келген есептік жазбаның әкімшісінен әрдайым нақты мақұлдау талап етіледі.
Пұблісһед	Егер есептік жазба саясаты Аллоу пұблісһед аппліцатіонс болса, бөлек мақұлдау талап етілмейді. Ол әлі де Аппровед аппліцатіонс онлy саясаты кезінде мақұлдауды талап етуі мүмкін.

Публикация — Планфіх тарапынан бөлек тексеріс. Қолданбаны жібермес бұрын айқын атау мен сипаттама, минималды сцопес жиыны, жұмыс істейтін редірецт ҰРЫ-лар және интеграцияны қосу мен жою бойынша пайдаланушы құжаттамасын дайындаңыз. Публикация процедурасы туралы Планфіх қолдау қызметімен хабарласыңыз.

Қосылу мекенжайлары

Глобал ОАұтһ эндпойнттарын пайдаланыңыз:

Пұрпосе	Аддресс
Аұтһорізатіон	`https://auth.planfix.com/oauth/authorize`
Токен	`https://auth.planfix.com/oauth/token`
Ұсерінфо	`https://auth.planfix.com/oauth/userinfo`
МЦП	`https://mcp.planfix.com/mcp`

Глобал ҰРЛ-ға есептік жазба атауын қоспаңыз. Пайдаланушы есептік жазбаны Планфіх бетіндегі таңдаудан таңдайды. Толық протокол, соның ішінде resource, ПКЦЕ, токен рефресһ және ревоцатіон туралы мәлімет Қосымшалар үшін ОАұтһ 2.0-те сипатталған.

Қолданбаны басқару

Партнер төмендегі әрекеттерді орындай алады:

Атау мен сипаттаманы өңдеу;
Редірецт ҰРЫ-ларды және сцопес-ты өзгерту;
Қолданбаны өшіру және қайта қосу;
Цонфідентіал қолданба үшін цліент сецрет-ті айналдыру (ротате);
Белгілі бір есептік жазба үшін қолданба мақұлдау сілтемесін генерациялау.

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

Қолданбаны өшіру ОАұтһ авторизацияны және шығарылған токендерді барлық есептік жазбаларда бұғаттайды. Бұл әрекет қолданбаны пайдаланатын барлық клиенттерге әсер етеді.

Іске қосуға дейінгі ұсыныстар

Аұтһорізатіон Цоде уітһ ПКЦЕ С256 қолданыңыз және state-ті тексеріңіз.
Тек қажет сцопес-тарды сұраңыз.
Кіруден кейін пайдаланушыға таңдалған есептік жазбаны көрсетіңіз.
Рефресһ токен айналдыруын (ротатіон) өңдеңіз: сәтті рефресһ-тен кейін алдыңғы рефресһ токен жарамсыз болады.
Токендерді, авторизация кодтарын, code_verifier немесе цліент сецрет-терді журналдарға жазбаңыз.
Пайдаланушылар интеграциядан қалай ажыратуға және деректерін жоюды қалай сұрауға болатынын құжаттаңыз.
Мақұлдау кері қайтару, қолданбаны өшіру және қайта қосу сценарийлерін тексеріңіз.