Ընդհանուր տեղեկատվություն
Այս ինտերֆեյսը թույլ է տալիս Ձեզ գործարկել cPanel API գործառույթները ինտերակտիվորեն:
- Այս ինտերֆեյսը հասանելի է միայն վերավաճառողների հաշիվներին:
- API Shell ինտերֆեյսում հասանելի են միայն cPanel API 2 եւ UAPI ֆունկցիաները:
Այս հատկությունը օգտագործում է ձեր սերվերի կենդանի տվյալները: API ֆունկցիայի կանչերը կարող են փոխել կամ ջնջել ձեր սերվերի տվյալները, ինչը կարող է հանգեցնել ձեր սերվերի ձախողման:
- Մանրակրկիտ կարդացեք ֆունկցիայի փաստաթղթերը նախքան այն օգտագործելը API Shell ինտերֆեյսում:
- Ֆունկցիայի ելքի օրինակը տեսնելու համար կարդացեք ֆունկցիայի Response samples բաժինը մեր cPanel Developer Documentation-ում:
Միացնել API Shell ինտերֆեյսը
Այս գործառույթից օգտվելու համար ձեր հոսթինգ պրովայդերը պետք է միացնի այն ձեզ համար: Խնդրեք նրանց կատարել հետեւյալ քայլերը WHM-ում.
- Ընտրեք On for the cPanel & WHM API shell (մշակողների համար) պարամետրը WHM-ի Tweak Settings ինտերֆեյսի System ներդիրում (WHM » Գլխավոր էջ » Սերվերի կոնֆիգուրացիա » Tweak Settings):
- Շնորհեք API Shell առանձնահատկությունը ձեր հաշվի առանձնահատկությունների ցանկում WHM-ի Feature Manager ինտերֆեյսում (WHM » Գլխավոր էջ » Փաթեթներ » Առանձնահատկությունների մենեջեր):
Կանչել API ֆունկցիա
API ֆունկցիա կանչելու համար կատարեք հետեւյալ քայլերը.
- Ընտրեք UAPI (API 3) կամ API 2 տարբերակը cPanel API տարբերակի բաժնում:
- Ընտրված API տարբերակի մենյուից ընտրեք API ֆունկցիան:
- Փոփոխականներ բաժնում մուտքագրեք API ֆունկցիայի բանալիները եւ արժեքները տեքստային վանդակներում: Եթե API ֆունկցիան ունի որեւէ պահանջվող բանալի եւ արժեքային զույգ, դուք պետք է մուտքագրեք դրանք:
- Նոր փոփոխականի գրառում ավելացնելու համար կտտա՛րեք Հավելել:
- Փոփոխականի գրառումը հեռացնելու համար կտտացրեք X պատկերակը:
- Արդյունքները զտելու, տեսակավորելու կամ էջավորելու համար կտտացրեք Ցուցադրել տեսակավորման/ֆիլտրի/էջահաշվարկի ընտրանքները.
- Արդյունքներից ցույց տալու համար առաջին գրառումը ընտրելու համար մուտքագրեք թիվ առաջին արդյունքների ցանկում, զրոյական տեքստային վանդակում կամ օգտագործեք մենյուը՝ թիվը ընտրելու համար:
- Արժեքը ցույց է տալիս անսահմանափակ արդյունքներ:
0
- Արժեքը ցույց է տալիս անսահմանափակ արդյունքներ:
- Ցուցադրվող արդյունքների քանակը սահմանափակելու համար մուտքագրեք մի թիվ Առավելագույն # արդյունքների տեքստային վանդակում կամ օգտագործեք ցանկը՝ թիվ ընտրելու համար:
- Արժեքը ցույց է տալիս անսահմանափակ արդյունքներ:
0
- Արժեքը ցույց է տալիս անսահմանափակ արդյունքներ:
- Արդյունքները ֆիլտրելու համար սեղմեք Ավելացնել ինտերֆեյսի Ֆիլտրեր բաժնում: Կարող եք նշել արդյունքները ֆիլտրելու համար օգտագործվող դաշտը, պայմանները (Պարունակում, Սկսվում է, Հավասար, Մեծ է (թվային) կամ Փոքր (թվային) եւ պայմաններին վերաբերող տերմինը:
- Նոր ֆիլտր հավելելու համար կտտացրեք Հավելել:
- Ֆիլտրը հեռացնելու համար կտտացրեք X պատկերակը:
- Արդյունքները տեսակավորելու համար սեղմեք Ավելացնել ինտերֆեյսի Տեսակավորում բաժնում: Դուք կարող եք նշել դաշտ, որով ցանկանում եք տեսակավորել արդյունքները, պայմանները (բառակապակցական, թվային, numeric_zero_as_max կամ ipv4), եւ արդյոք պետք է փոխել տեսակավորման կարգը:
- Տեսակավորման նոր մեթոդ ավելացնելու համար կտտացրեք Հավելել:
- Տեսակավորման կարգը հեռացնելու համար կտտացրեք X պատկերակը:
- Ցուցադրվող սյունակները սահմանափակելու համար սեղմեք Ավելացնել ինտերֆեյսի Սյունակներ բաժնում: Այնուհետեւ, մուտքագրեք սյունակի համարը սյունակում տեքստային վանդակում:
- Ցուցադրելու համար լրացուցիչ սյունակներ ավելացնելու համար կտտա՛րեք Հավելել:
- Սյունակը հեռացնելու համար սեղմեք X պատկերակը:
- Արդյունքներից ցույց տալու համար առաջին գրառումը ընտրելու համար մուտքագրեք թիվ առաջին արդյունքների ցանկում, զրոյական տեքստային վանդակում կամ օգտագործեք մենյուը՝ թիվը ընտրելու համար:
- Սեղմեք Ներկայացնել:
API ֆունկցիայի արժեքները փոփոխելիս ինտերֆեյսը թարմացնում է URL եւ API զանգի տվյալների կառուցվածքի բաժինների գրառումները։
API զանգի պատասխան
Ներկայացնել սեղմելուց հետո API ֆունկցիայի վերադարձները հայտնվում են ինտերֆեյսի API զանգի պատասխանի բաժնում: Արդյունքները կարող եք դիտել Ծառի տեսքում, Աղյուսակի տեսքում եւ Հում տեսքում ներդիրներում:
- Raw view ներդիրը առանձնացնում է API զանգի պատասխանը HTTP վերնագրերից:
- Աղյուսակի տեսքը կարող է անհասանելի լինել որոշակի ֆունկցիաների տվյալների համար:
