Перейти к основному содержанию
Кілт платформа экрандарында шығарылады: Платформа → API кілттері → Кілт шығару. Сіз кілтке атау бересіз, компаниялар мен құқықтарды таңдайсыз, қажет болса шығын шегі мен мерзімді бересіз. Кілт толық күйінде бір рет, шығарылғаннан кейін бірден көрсетіледі. Кілтті ұйымның иесі немесе әкімшісі шығара алады. Қалғандарына бөлім жабық, экранда «Қолжетімділік жоқ» деп жазылады. API кілтінің өзімен кілттер шығарылмайды және өзгертілмейді, мұны тек кабинеттегі адам жасайды.

​
Кілт шығару

1

«API кілттері» бөлімін ашыңыз

Кабинет мәзірінде Платформа сілтемесін басыңыз, API кілттері бөлімін таңдап, Кілт шығару батырмасын басыңыз. «Жаңа кілт» терезесі ашылады.
2

Кілтке атау беріңіз

«Атауы» өрісіне кілттің қайда қолданылатынын жазыңыз, мысалы «CRM-мен интеграция». Кейін кілтті тізімнен де, шығыннан да осы атау бойынша табасыз.
3

Компаниялар мен құқықтарды таңдаңыз

«Қолжетімділік» қадамында «Ұйымның барлық компаниялары» нұсқасын қалдырыңыз немесе керек компанияларды белгілеңіз. «Осы кілтпен не істеуге болады» блогында құқықтарға белгі қойыңыз.
4

Шекті, мерзімді және мекенжайларды беріңіз

«Шек және мерзім» қадамында міндетті емес үш өріс бар: «Айлық шығын шегі», «Дейін әрекет етеді» және «Рұқсат етілген мекенжайлар». Бос шек «шексіз» дегенді, бос мерзім әдепкі мерзімді, мекенжайлардың бос тізімі «кез келгенінен» дегенді білдіреді.
5

Кілтті көшіріп алыңыз

Шығарылғаннан кейін «Толық кілт» өрісінде кілт толық күйінде көрсетіледі. Көшіру батырмасын басып, оны серверіңіздің құпиялар қоймасына сақтаңыз. Кілт екінші рет көрсетілмейді.
Шығарғаннан кейін экран ескерту көрсетсе, кілт жасалған, бірақ ол арқылы ЖИ-бухгалтерге сұраулар әзірге өтпейді. Әдеттегі себеп — платформа балансының бос болуы: Платформа балансы және шығын бетін қараңыз. Ұйымдағы кілттер саны шектеулі. Өшірілген кілттер де есепке кіреді. Шекке жеткенде кілт шығару api_keys_limit кодымен қате қайтарады: керексіз кілттерді кері қайтарыңыз.

​
Құқықтар мен компаниялар

Кілт оны шығарған адамның атынан әрекет етеді және ешқашан оның құқықтарынан аспайды. Әр компаниядағы әр құқық осы адамның құқықтары бойынша тексеріледі. Ол ұйымның иесі немесе әкімшісі болудан қалса, кілт басқа адамға берілгенше жұмыс істемейді. Құқық жетеу. API сұраулары мен жауаптарында олар әр жолдың басында көрсетілгендей аталады.
  • company.read — «Компания деректерін оқу». Әр кілтте бар.
  • chat.use — «ЖИ-бухгалтермен жұмыс істеу». ЖИ-ге қойылатын сұрақтар мен тапсырмалар, платформа балансынан төленеді.
  • proposals.create — «1С үшін құжаттар дайындау». ЖИ-бухгалтер құжатты дайындайды, кейін оны адам мақұлдайды.
  • proposals.approve — «Құжаттарды мақұлдап, 1С-ке жазу». Кілт құжаттарды 1С-ке өзі жазады, бұл құқықты абайлап беріңіз.
  • automations.read — «Автоматтандыруларды көру». Сценарийлер, хуктар және іске қосулар, тек қарау.
  • automations.manage — «Автоматтандыруларды басқару». Сценарийлерді жасау, өзгерту және іске қосу.
  • webhooks.manage — «Вебхуктерді басқару». Тек барлық компанияға арналған кілтке қолжетімді, өйткені оқиғалар бүкіл ұйым бойынша келеді.
Барлық компанияға арналған кілт болашақта қосылатын компанияларды да көреді, бірақ тек кілтті шығарған адам мүше болғандарын. Әр компанияда кілт осы адамның сондағы рөлі рұқсат ететіннен артық ештеңе істей алмайды. «Рұқсат етілген мекенжайлар» өрісі кілттің сұрауларды қайдан қабылдайтынын шектейді. Онда IP-мекенжайлар мен ішкі желілер үтір арқылы тізіледі. Басқа мекенжайдан келген сұрау ip_not_allowed кодымен 403 бас тартуын алады. Жұмыс істеп тұрған кілттің компанияларын, құқықтарын және мерзімін тек оны шығарған адам өзгертеді: кілт мәзірі, Өзгерту тармағы. Басқа әкімші кілтті тек тарылта алады: шекті төмендетеді немесе мекенжайлар тізімін қысқартады.

​
Жарамдылық мерзімі

Мерзім әр кілтте бар. «Дейін әрекет етеді» өрісін бос қалдырсаңыз, әдепкі мерзім қолданылады, қазір ол 90 күн. Мерзім бітуіне 14 күн және 3 күн қалғанда кілт авторына хат келеді, ал вебхук мекенжайларына api_key.expiring оқиғасы жіберіледі. Кілт жарамды болып тұрғанда оның мерзімін «Өзгерту» арқылы ұзартуға немесе қысқартуға болады. Мерзімі өткен кілтті ұзартуға болмайды: әйтпесе ескі құпия қайта жұмыс істеп кетер еді. Мерзімі өткен кілтті жұмысқа қайтару үшін оны қайта шығарыңыз. Құқықтар, компаниялар және шек сақталады, мерзім жаңадан басталады, ал құпия жаңа болады.

​
Өшіру, қайта шығару, беру, кері қайтару

Барлық әрекет тізімдегі кілттің мәзірінде орналасқан. Өшіру тармағы кілтті бірден тоқтатады, оны кері қосуға болады. Ол арқылы жіберілген сұраулар key_disabled кодымен 401 бас тартуын алады. Құпия, құқықтар және мерзім өзгермейді. Осы кілтпен сақталған автоматтандыру сценарийлері ол өшірулі тұрғанда іске қосылмайды. Кілтті кез келген ие немесе әкімші өшіре алады, ал қайта қосуды тек кілт авторы немесе ұйым иесі жасайды. Қайта шығару тармағы сол кілтке жаңа құпия береді. Жаңа кілт шығару кезіндегідей толық күйінде бір рет көрсетіледі. Бағдарламаңыз ауысып үлгеруі үшін бұрынғы құпия әлі біраз уақыт жұмыс істейді: қай сәтке дейін екені «Бұрынғы құпия дейін жұмыс істейді» жолында жазылған. Қайталап қайта шығару бұрынғы құпияны бірден тоқтатады. Кілтті тек оның авторы қайта шығара алады. Беру тармағы кілт авторы кетіп, интеграция қалатын кезде керек. Кілт ұйымның басқа иесінің немесе әкімшісінің атынан әрекет ете бастайды. Құпия мен мерзім бұрынғыдай қалады. Кілтті тек кілт компанияларындағы құқықтары кілт құқықтарына жететін адамға беруге болады.
Кері қайтару тармағы кілтті біржола өшіреді, оны қайтару мүмкін емес. Осы кілтті қолданатын бағдарламаларға жаңа кілт керек болады. Кері қайтарылған кілтпен сақталған автоматтандыру сценарийлері онымен бірге өшеді.
Кілт бөгде адамдарға түсуі мүмкін болса, оны кері қайтарыңыз немесе бірден өшіріп, содан кейін анықтаңыз. Кілт бойынша сұраулар журналы «Сұраулар журналы» бөлімінде, кім нені өзгерткені «Әрекеттер журналы» бөлімінде жатыр. Ұйым иесі кілттерге толық тыйым сала алады: ұйым баптауларындағы «API кілттеріне рұқсат беру» баптауы. Оны өшірсеңіз, жаңа кілттер шығару мүмкін болмайды, ал жұмыс істеп тұрғандары бірден тоқтайды.

​
Әрі қарай