Kapsule Orbit API Tokens me te REST API

API tokens let a script, a CI pipeline or your own tooling drive Orbit without a browser session: trigger deployments, report CI check results, download build artifacts, manage cron jobs and more…

Ngā Tohu API Orbit me te REST API

Kā tohu API e tuku i te script, i te pīpeline CI rānei i ō ake āwhina kia pukumahi i Orbit me te kore o te rūnanga poroporoaki: whakahohe tuku, tāputa hua tirotiro CI, tiki hua hanganga, whakahaere mahi cron me ā ētahi atu mea, katoa i te whakamana mā te tohu Bearer i whakarite e koe.

Kei Hea Ngā Tohu

Whakatūtuki Orbit me te whiriwhiri Tokens i te whakatika takiwā tīpako. Ko te ūpoko o te whārangi ko API Access Tokens a e whakatakoto ana i tōna āhuatanga noa iho: e kitea ana ngā tohu i te wā tumuaki anake.

Kei te wāhi kotahi ahumahi ake te tuhinga pūtaiao tohu katoa. Ko te kaari API Reference he pūtton View docs hei whakatū i te whakaatu roto-whārangi mō ia pito Orbit.

API Access Tokens page in Orbit

Te Waihanga Tohu

Pīoioi New token.
Homai he ingoa mō tēnei: Token name. Whakaingoa ia ki te āhuatanga ka whakamahi i a ia, hei tauira te mahi workflow CI, kia pai ai te āta wetewete i muri mai.
Whiriwhiri Scopes.
Mēnā e hiahia ana, tohu he Expiry. Waiho he mokowā ina kore e pāheke te tohu.
Pīoioi Create token.

E whakaaturia ana te tohu tūturu i te wā kotahi, i raro i te ūpoko One-time reveal, me te pūtton tāruarua. Whakatakihia tika ki tō pūkete huna CI. Kāhore he huarahi kia kite i a ia anō: ko te SHA-256 hash anake o te tohu kei te rokiroki, nō reira kaore a Kapsule e ahei ki te tiki anō mō koe.

E taea e te kaute te pupuri ki te 20 tohu kaha. Kāore e whakakāhia te rua tekau mā tahi mē meatia me te karanga kia tangohia tēhihi e whai mua.

Kaua e whakatakihia he tohu ki te karere kōrero, ki te tikete, ki te kupu tuku rānei ki te papatupu. He tohu me deploy:write e taea ai te tuku whakatika ki te tūmataiti, a he tohu me env:write e taea ai te pānui me te whakakapi i tō whiriwhiringa ahuatanga. Me tiaki i a ia pērā anō me te kupu whakarite.

Scopes

Ko ngā Scopes te āhuatanga katoa o ngā tohu: kei ia kotahi anake ngā whakaaetanga i homai e koe.

Scope	Tuku
`deploy:write`	Whakahohe me te whakahaere tuku
`project:read`	Pānui i ngā taipitopito kaupapa me te taiao
`project:write`	Tūtaki i ngā tautuhinga kaupapa
`env:read`	Pānui i ngā kupu whiriwhiri ahuatanga metadata
`env:write`	Tohu me te whakakore kupu whiriwhiri ahuatanga

Ka tūtei ki te deploy:write me project:read te tohu hōu, ko ia nei te āhuatanga e hiahia ai te pīpeline tuku a kore ō tēhihi atu.

Tuku te iti rawa kia meatia ai te mahi. Kaore he tohu e hiahia anake ki te tāputa hua tirotiro CI i te hiahia project:write. Kaore he tohu pānui anake mō te tirotiro i te mea kaha i te hiahia i te scope tuhi. E tuhia ana i ia pito i te whakaatu whakahuatanga te scope iti rawa e hiahia ai.

Te Whakamahi Tohu

Ko te whakamana he ūpoko Bearer i te API tīpako, https://kapsulehost.com:

curl -X POST https://kapsulehost.com/api/orbit/$ORBIT_PROJECT_ID/deployments \
  -H "Authorization: Bearer $ORBIT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"branch":"main"}'

Ko te whārangi Tokens he tohu rite tūturu CI/CD usage me te mahi tīmata GitHub Actions. E raka ana te tīmata hei .github/workflows/orbit-deploy.yml me te hiahia ki ngā huna repository e rua, ORBIT_TOKEN me ORBIT_PROJECT_ID. Tāruarua te rua mai i te whārangi, kaua e whakatuhituhi.

He Aha te Āwhi API

E tuhia ana i te whakaatu roto-whārangi ia āwhi me ngā tawhāwhā me te scope e hiahia ana:

Deployments: whakahohe tuku, kore rānei i tēhihi peka, kore rānei e rōrā mō te wā kei te awe ake i whakaritea, i waenga e rima meneti me te tīpu rā tīpiti, me te tuhituhi itiiti rawa atu ki te rau ngā pūāhua. Ko te whakatuatuatanga e hāngai ana ki te raupapa ngoikoiki i te kupu tuku, te karere, te peka me te kaiparepare, me ngā tāhei i te peka, te ahuatanga me te taiao, me te pokapokahanga kōpokapoka ki te 100 hua i te whārangi.
Deployment checks: whakamahanatanga he waharoa kounga i te tīmata o tō mahi CI, katahi me te tāputa i te hua i te mutunga. Ko te kuputaka required e rahua ana e nekehia te tuku ki FAILED a e hoki anō te taiao ki te tuku ōrite ake i mua, ko ia nei te momo ki te whakapūmau i ō ake tīmatarau he waharoa tuku tūturu.
Branch protection: ngā ture tauira-riwai e whakamatara ai i ngā tuku auatika kia tae ko ngā kuputaka e hiahiatia ana ka riro tukua rānei kēnei tāngata. Ki te tekau ture itiiti i ia kaupapa.
Build artifacts: tiki he wāhi tīpako tohu-noa mō te huanga hanganga i ōrite ai te tuku. Ka mau te wāhi mō te tekau mā rima meneti.
Project transfer: whakahohe, whakamatara me te tirotiro i te ahuatanga o te whakakaupapa ki tēhihi kaute. Tirohia Transferring an Orbit Project.
Cron jobs: whakatuatuatanga, waihanga, whakahou, whakakore, whakahohe, me te pānui i te hītori whakamahi. Tirohia Orbit Cron Jobs.
Timeline annotations: waihanga me te whakahaere i ngā tohu pūruru, tuku, wāmitanga, tuhituhi me te haki. Tirohia Orbit Timeline Annotations.
Status page: pānui me te tuhi i te whiriwhiringa whārangi ahuatanga pokapoka. Tirohia Orbit Status Page.
Edge functions: whakatuatuatanga, waihanga, whakahou me te tuku i ngā kaipatuari tahi. Tirohia Orbit Edge Functions.

E mahi tahi ana te whakamana rūnanga mai i te waipapa me ngā tohu Bearer, nō reira te pito e taea e koe te karanga mai i tō poroporoaki e taea te karanga mai i te whakataukī hoki.

Turbo Remote Cache

E whakatakoto ana te whārangi Tokens i te kaari Remote Build Cache. E whakamahi ana i te Turborepo Remote Cache Protocol, e tuku ana kia whakatuakihia ngā cache hanganga i waenga i ngā tumatanui CI me ngā pēke kaihanga.

Whakahohe ki te kaari, tāruarua te tohu ka waihangaia ai, me te tohu iho hei TURBO_TEAM i tō ahuatanga CI. E takahi ana ngā hua itiiti rawa atu ki te 150 MB i ia. E whakatukutuku ana te kaari i te Rotate token me te Disable.

Mēnā e pau ana te wā CI o tō monorepo ki te waihanga anō i ngā pūkete kaore i te rerekē, ko ia nei te mea ki te tapa nui rawa i te whārangi.

Te Whakahaere Taonga

Ko te Token inventory he rārangi i ia tohu kaha me:

I te wā i Created.
I te wā i Last used, rānei Never.
I te wā e Expires, me he haki expired i muri i te pāheke.

Ko te pou Last used te mea hei arotake. He tohu kaore i whakamahi i te wā kotahi rānei he hē i te whiriwhiringa, a i ia tohu kaore i te mahi. E whakatakoto ana te tohu whakaaro a te whārangi: whakakore i ngā tohu kaore e mōhio ai.

Te Whakakore Tohu

Pīoioi te ture whakakore i te rārangi. Ko te whakatautokongia: ko ia mea e whakamana ana me tērā tohu ka ngarū ake tonu, a kaore he whakahoki.

Whakakore ina paihia te pīpeline, ina haere ake te tangata e whakawhiwhia ki ō huna CI, rānei i te wā tupu kua whakawhiwhia te tohu. Kaore he whakakore waiwai me te wā tuku, ko ia nei te āhuatanga e hiahia ai i te tohu whakawhiwhia.

Tohu he pāheke i ngā tohu ka waihangaia e koe mō te mahi kotahi anake. E horoia a ia e te tohu e pāheke ana; ko te tohu tonutanga i waihangaia mō te whakakaupapa rua rā e tohu ana e rua tau i muri.

Whakahokinga

401 Unauthorized. He hē te ūpoko rānei kua whakakore te tohu rānei kua pāheke. Tirohia he Authorization: Bearer <token> te ūpoko me te mokowā kotahi, a kaore tō huna CI i te kupu pikau.

403 Forbidden. Ko te tohu he tika tahi kāhore kāore he scope mō tērā pito. E tuhia ana i te whakaatu whakahui te scope iti rawa i ia pito. Ko ngā scope e tohua i te waihanga, nō reira waihanga he tohu hou me te huinga tika.

429 on creation. Kei te rua tekau tohu rokiroki. Whakakore tēhihi mai i te taonga.

The artifact URL stops working. E mau ana ngā wāhi tohu-noa mō te tekau mā rima meneti. Tiki he hou rawa kāhore te rokiroki wāhi.

A scheduled deployment is rejected. Me waenga te wā rōrā i waenga e rima meneti me te tīpu rā tīpiti ki mua.

Haere Ki Hea I Muri

Deploying Your Project mō te āhuatanga o te tuku i whakahohe ai.
Orbit Deployment Pipeline kia kite i ngā waharoa ka tutuki e ō API tuku.
Orbit Plan Limits mō te āhuatanga o tō mahere.