Skip to content

Seriktesterge arnalğan OAuth qosımşalar

Partner-menşigindegi OAuth qoldanbası birneşe Planfix eseptik jazbaların baýlanıstıratın ïntegracïyağa arnalğan. Barlıq klïyenttik eseptik jazbalar üşin birdeý qoldanba tirkelgi derekteri paýdalanıladı, alaýda ärbir eseptik jazba qabıldawdı bölek baqılaýdı jäne ärbir paýdalanwşı öz atınan qosılwğa kelisim beredi.

Eger ïntegracïya tek bir eseptik jazbağa arnalğan bolsa, account-owned application jasaw oñaýıraq.

Qoldanbanı qurw

  1. Öz partner eseptik jazbañızdı aşıñız.
  2. OAuth applications bölimine ötiñiz.
  3. Create application tañdañız.
  4. Paýdalanwşılar men äkimşiler köretin ataw men sïpattamanı engiziñiz.
  5. OAuth klïyent türin tañdañız.
  6. Redirect URI-lardı qosıñız.
  7. REST API üşin eñ az qajetti ruqsattardı (scopes) tañdañız.
  8. Qoldanbanı saqtap, onıñ tirkelgi derekterin köşirip alıñız.

Jaña qoldanba jeke bolıp tabıladı jäne oğan qosılatın ärbir eseptik jazbada naqtı maquldaw qajet.

OAuth klïyent türi

Type Intended applications Credentials
Public Mobïlʹdi, desktop jäne brawzerlik qoldanbalar, sonımen qatar jergilikti MCP klïyentteri. Tek bir client_id. Klïyenttik qupïya joq; PKCE S256 mindetti.
Confidential Qupïya server jağında saqtalatın jäne klïyent jağındağı kodta saqtalmawı mümkin qoldanbalar. client_id jäne client_secret.

OAuth klïyent türi qoldanbanıñ jarïyalanğan-jarïyalanbağan bolwınan bölek. Mısalı, jeke mobïlʹdi qoldanba — qupïyası joq public OAuth klïyenti.

Redirect URI-lar

Planfix paýdalanwşını jüýege kirwden keýin qaýtarwı mümkin ärbir URL-dı körsetiñiz.

  • Veb qızmet üşin https qoldanıñız.
  • http tek localhost jäne 127.0.0.1 sïyaqtı loopback mekenjaýlar üşin ruqsat etiledi.
  • Loopback mekenjaýı üşin klïyent dïnamïkalıq port qoldana aladı, biraq sxema, xost, jol jäne suraw jolı däl säýkes bolwı tïis.
  • Wildcard-tar, URL fragmentteri nemese siz baqılamaýtın redirect URI-lardı qoldanbañız.

Scopes

Scopes qoldanbanıñ maksïmaldı ruqsattarın anıqtaýdı. Tek qana REST API scope list-ten qajetti ruqsattardı surañız.

Qoldanba scopes-peri paýdalanwşınıñ qalıptı ruqsattarın almastırmaýdı. Scope berilgen jağdaýda da qoldanba tek sol paýdalanwşığa qoljetimdi derektermen ğana jumıs isteý aladı.

Redirect URI-lardı nemese scopes-tı özgertkende jaña maquldaw nusqası paýda boladı. Burın qosılğan eseptik jazbalar jaña nusqanı qarap, maquldawı qajet, al paýdalanwşılar qaýtadan qosılwları tïis.

Klïyent eseptik jazbasın qosw

Jeke partner-menşigindegi qoldanba ärbir eseptik jazbada äkimşi tarapınan naqtı maquldawdı talap etedi.

  1. Partner eseptik jazbañızda qoldanbanı aşıñız.
  2. Approval link aýmağına klïyent eseptik jazba atawın engiziñiz.
  3. Generacïyalanğan siltemeni köşirip, sol eseptik jazbanıñ äkimşisine jiberiñiz.
  4. Äkimşiden ïyesin, redirect URI-lardı jäne scopes-tı tekserip, qoldanbanı maquldawın surañız.
  5. Maquldawdan keýin eseptik jazbadağı paýdalanwşılar OAuth avtorïzacïyasın ayaqtaý aladı. Är paýdalanwşı öz atınan bölek kelisim beredi.

Bul silteme Account management → API → OAuth and MCP applications betin aşadı jäne suralatın qoldanbanı körsetedi.

Qoswmen birge äkimşi qoldanbanı tañdağanda Approve and connect opcïyasın tañdaý aladı.

Jeke jäne jarïya qoldanbalar

Status How it is admitted to an account
Private Kez kelgen eseptik jazbanıñ äkimşisinen ärdaýım naqtı maquldaw talap etiledi.
Published Eger eseptik jazba sayasatı Allow published applications bolsa, bölek maquldaw talap etilmeýdi. Ol äli de Approved applications only sayasatı kezinde maquldawdı talap etwi mümkin.

Pwblïkacïya — Planfix tarapınan bölek tekseris. Qoldanbanı jibermes burın aýqın ataw men sïpattama, mïnïmaldı scopes jïını, jumıs isteýtin redirect URI-lar jäne ïntegracïyanı qosw men joyu boýınşa paýdalanwşı qujattamasın daýındañız. Pwblïkacïya procedwrası twralı Planfix qoldaw qızmetimen xabarlasıñız.

Qosılw mekenjaýları

Global OAuth éndpoýnttarın paýdalanıñız:

Global URL-ğa eseptik jazba atawın qospañız. Paýdalanwşı eseptik jazbanı Planfix betindegi tañdawdan tañdaýdı. Tolıq protokol, sonıñ işinde resource, PKCE, token refresh jäne revocation twralı mälimet Qosımşalar üşin OAuth 2.0-te sïpattalğan.

Qoldanbanı basqarw

Partner tömendegi äreketterdi orındaý aladı:

  • Ataw men sïpattamanı öñdew;
  • Redirect URI-lardı jäne scopes-tı özgertw;
  • Qoldanbanı öşirw jäne qaýta qosw;
  • Confidential qoldanba üşin client secret-ti aýnaldırw (rotate);
  • Belgili bir eseptik jazba üşin qoldanba maquldaw siltemesin generacïyalaw.

Secret-ti aýnaldırğannan keýin eski client secret derew jumıs istemeýdi. Secret-ti ïntegracïya serverinde jañartıñız jäne onı paýdalanwşılarğa eşqaşan jibermeñiz.

Qoldanbanı öşirw OAuth avtorïzacïyanı jäne şığarılğan tokenderdi barlıq eseptik jazbalarda buğattaýdı. Bul äreket qoldanbanı paýdalanatın barlıq klïyentterge äser etedi.

İske qoswğa deýingi usınıstar

  • Authorization Code with PKCE S256 qoldanıñız jäne state-ti tekseriñiz.
  • Tek qajet scopes-tardı surañız.
  • Kirwden keýin paýdalanwşığa tañdalğan eseptik jazbanı körsetiñiz.
  • Refresh token aýnaldırwın (rotation) öñdeñiz: sätti refresh-ten keýin aldıñğı refresh token jaramsız boladı.
  • Tokenderdi, avtorïzacïya kodtarın, code_verifier nemese client secret-terdi jwrnaldarğa jazbañız.
  • Paýdalanwşılar ïntegracïyadan qalaý ajıratwğa jäne derekterin joyudı qalaý surawğa bolatının qujattañız.
  • Maquldaw keri qaýtarw, qoldanbanı öşirw jäne qaýta qosw scenarïýlerin tekseriñiz.

Ötw