Pūkete
Kupu Matua API me te Whakauru Kaipānui
Kapsule gives you two developer surfaces: scoped API keys for reading your account programmatically, and a remote build cache that speeds up Turborepo and Nx builds on your own machines and CI…
Ko Kapsule he rua āhuatanga kaiwhakapaipai: he tohu API whakatūturutanga mō te pānui i tō pūkoro mahi pokapū, me te pūmahara hanga tawhārangi e tere ai a Turborepo me Nx hanga i runga i ō ake miihini me ō CI āwhitanga.
Kaore i te whakahohē taunoa. E rua nei ka hangaia mai i Settings, ā, e rua nei ka tuku mai he huna i a koe kotahi noa iho.
Te Hanga Tohu API
E noho ana ngā tohu API i raro i Settings, ānei ki Security, i te API Keys āhei.
- Haere ki Settings, ānei ki Security.
- Tomokia ki API Keys me pīkau New key.
- Homai he ingoa mō te tohu. E whakaaro ana te āpure i "Key name (e.g. My automation script)". Ko te ingoa mō koe anake, no reira me kī mai ko hea te tohu e whakamahia ai.
- Pīkau i ngā chips āhuatanga kia kōwhiri i ngā mea e āhei ai te tohu. E toru ngā āhuatanga pānui kua whakatae:
read:sites,read:email, meread:domains. Pīkau i te chip kia tāpiri, kia tango rānei. - Pīkau Create.
Ka puta te tohu katoa kotahi noa iho, i te paanui karakariki e whakatupuranga "Copy now". Tikiritia atu ki tō pūmahara huna. Kia kore e whakatūturu te paanui, kua ngaro te tohu: ko te waahanga poto anake e pupuri ana, ko te mea anake ka whakaatu mai te rārangi i muri mai.
Kaore te tohu e whakaaturia i te tuarua, kāore hoki e taea te whakaorangia. Ki te wareware koe, whakarewea te tohu nei, ā, hangia he hou. Kāpai koe e takoto ai ki te taonga tahi, ki te kaihanga, ki te tuku, ki te īmēra rānei.
Ko te Owner me te Admin noa iho ngā mea ka taea te hanga tohu. Ki te atu atu ake te mana, ka puta he hapa whakaaetanga. I te wā ka hangaia he tohu, ka tukua he īmēra amuamu toiora ki te wāhi o te kaituhituhi, no reira he ahuatanga tūturu i taua wā he pai ki te tirotiro tōnutanga.
Ngā Āhuatanga
E whitu ngā āhuatanga:
| Āhuatanga | Tukua |
|---|---|
read:sites | Te pānui i ō papaaho |
write:sites | Te tukunga kua whakatae mō ngā whakatairanga papaaho |
read:email | Te pānui i ō pouaka īmēra |
write:email | Te tukunga kua whakatae mō ngā whakatairanga pouaka īmēra |
read:domains | Te pānui i ō āhuatanga |
write:domains | Te tukunga kua whakatae mō ngā whakatairanga āhuatanga |
read:billing | Te tukunga kua whakatae mō te pānui i ngā raraunga utua |
Ko te API kaihōkoi he pānui noa iho i tēnei rā. Ko ngā āhuatanga write: me read:billing e taea ana te kōwhiri i te tohu, engari kaore he putanga kaihōkoi e tango ana i ēnei, no reira ko te tuku i ēnei kaore he huringa. Tukua noa iho ngā āhuatanga pānui e hiahia nui ai koe, ā, tirohia anō te tohu i te wā ka eke atu ngā putanga whakatairanga.
Te Whakamahi i te Tohu
Tukua te tohu hei tohu kawekawe i te Authorization upoko.
curl https://kpanel.kapsulehost.com/api/v1/sites \
-H "Authorization: Bearer YOUR_KEY_HERE"
E toru ngā putanga e whakaae ana ki te tohu API kaihōkoi:
| Putanga | Āhuatanga e hiahiatia | Ka homai |
|---|---|---|
GET /api/v1/sites | read:sites | Ō papaaho, me te āhuatanga, momo tono, me te āhuatanga |
GET /api/v1/domains | read:domains | Ō āhuatanga, me te āhuatanga me te wānganga |
GET /api/v1/mailboxes | read:email | Ō pouaka īmēra |
Ko te tono me te tohu kore, me te tohu kāore i te mōhio, me te tohu i whakarewea ka homai 401. Ko te tohu kairangi kahakore te āhuatanga tika ka homai 403 me he karere e whakaingoa ana i te āhuatanga i hiahiatia. Ko ia karanga angitu ka whakahou i te tohu o te wā i whakamahia.
Tūtoki noa. E pānui ana ngā putanga i ngā raraunga pūkoro ora, ā, ko te taura memeoro ki ō reira he rite ki te kino. Ko te kotahi meneti i te nui mō te mea e tika ai te papa arotau; ko te kotahi hāora i te nuinga o ngā wā he nui.
Te Arotau me te Whakarewea i ngā Tohu
E whakaaturia ana e te rārangi API Keys ia tohu ora e te Name, Prefix (te matamata o te tohu), me Scopes. Pīkau Revoke i te mutunga o te rārangi kia patua.
Ko te whakarewea ka mahi tōnutanga, ā, kaore he kōwhiri whakaūnga. Ko te tono i muri me taua tohu ka hapa me 401. E kore e taea te whakaorangia he tohu i whakarewea, no reira kia mārama koe ki te mea e whakamahi ana i mua i a koe e pīkau.
Ko ngā tohu he āhuatanga pūkoro, ehara i te tangata i hanga ai. E kore e whakarewea ngā tohu i hanga ai e te hoa i te wā ka whakamutu ia mai i te whārangi Team. Whakatakotoria he arotau tohu ki ō mahi whakamutu: whakakore te tangata, ānei haere mai anō, ā, whakarewea te mea i hanga ai.
Ko te hanga tohu me te whakarewea e rua nei e īmia ana i te rārangi arotau i raro i ngā mahi api_key.*, me te kaihanga me te wāhi IP i puta mai.
Te Pūmahara Hanga Tawhārangi
Ko te whārangi Developer, i te rōpū Tūturu o te rakiraki tūranga, he Remote Build Cache. Ka whakaahuatia e te paanui he huarahi kia "Accelerate Turborepo me Nx hanga ma te toha i te pūmahara tohatoha puta noa i ngā miihini me ngā paipa CI."
- Haere ki Settings, ānei ki Developer.
- Pīkau Enable remote cache.
- Tikiritia te tohu mai i te paanui e whakatupuranga "New token generated. Copy it now, it won't be shown again".
Ānei tautuhia e rua ōrau tūranga taiao i ō tūranga CI, i ō ake .env.local:
TURBO_TOKEN=<your-token>
TURBO_TEAM=<your-account-id>
Ko te ID rōpū ko ō Kapsule pūkoro ID, e whakaaturia ana i ngā tohutohu whakatūranga i te whārangi ānō.
E kōrero ana te whārangi i tōna ake whakatairanga: Turborepo 1.x ake, Nx 16 ake, me te taputapu e tutuki ana i te kaupapa pūmahara tawhārangi ānō. Ka penapena ngā mea i te pūkoro tētahi, ā, e kore nei e toha i roto i te āhuatanga pūkoro.
E rua atu ngā whakahaere e noho ana i te āhei:
- Rotate token he hoatu tohu hou, me te whakakore i te mea tawhito. Ka puta he mahinga CI e pupuri ana i te tohu tawhito ka mutu te whakamahi i te pūmahara, no reira ka hurihia, ka whakahou i ō huna tahi.
- Disable ka whakatū te pūmahara i te katoa.
Te Kōwhiri i Waenganui i te Rua
E whakatau ana ki ngā raru kāore e ōrite, ā, e kore e moemoe whakarite.
Whakamahia te API key mēnā ka hiahia te āhuatanga kē i a Kapsule ki te mōhio i te āhuatanga o tō pūkoro: he papa tūranga e tīraupi ana i ō papaaho, he patuari ka whakatupato ai koe i ngā āhuatanga e pā ana whakamutunga, he tukuwhāiti taonga.
Whakamahia te remote build cache mēnā ka tere ke te hanga nā te mea ka hanga anō ia miihini, ia mahinga CI i ngā pūtohu kāore nei kua hurihia. Kaore e mea ki ō papaaho kua noho, ā, e kore e pānui i ō raraunga pūkoro.
Ki te tuku mai koe i te Git, kaua te karanga API, titiro ki Kapsule Orbit. Ka hanga, ka uiui mai i tō pūtaka tūmataiti, me te pūmahara hanga ka whāngai mōu.
Te Whakatuturi Rapunga
Ka homai ia tono he 401. Whakaūnga koe i te pūrongo i te upoko hei Authorization: Bearer <key> me te wāhi kotahi, kahore i te tohu i poroporoaki i a koe i tikiritia, ā, kaore kia whakarewea. Tautuhi i te timatanga o tō tohu me te āhuatanga Prefix hei whakaūnga koe e whakamahi ana i te tohu e whakapae ana koe.
Ko te tono ka homai he 403 e whakaingoa ana i te āhuatanga. Kaore te tohu i karanga i taua āhuatanga. Ko ngā āhuatanga e whakatau tūturu i te wā ka hangaia te tohu, no reira hahia he hou me ngā āhuatanga tika, ā, whakarewea te mea tawhito.
E kore nei e kite te āhei API Keys. E noho ana i te whārangi Security, ehara i te whārangi Developer. Ko te whārangi Developer he pūmahara hanga anake.
Ko te pātene New key e kore e mahinga. Ko tō mana i raro i Admin. Āwhina mai i te Owner, i te Admin rānei.
E kore nei te hanga e paona i te pūmahara. Whakaūnga koe kua kei te taiao hanga te rua i TURBO_TOKEN me TURBO_TEAM, kahore kia hurihia te tohu i muri i tō tautuhinga, ā, e whakaatu ana te whārangi i te paanui Active.
I puta mai he tohu kihai i hanga e au. Mahitia hei pokapū. Whakarewea, ānei haere whānuitanga i Account Security me te tirotiro i te rārangi arotau mō ngā mea kē i hurihia.