Ceļveži

Sāciet darbu ar Nubbo API

No nulles līdz pirmajam pieprasījumam dažās minūtēs. Izveidojiet atslēgu un sāciet pārvaldīt savu krātuvi no sava koda.

Nubbo API ir REST API darbam ar jūsu bucket no jūsu pašu koda: faili, mapes, saites, failu pieprasījumi, galerijas, etiķetes, projekti un automatizācijas. Šajā ceļvedī jūs izveidosiet atslēgu un nosūtīsiet pirmos pieprasījumus ar curl.

Ko jūs iegūstat

  • Pārvaldiet savu Nubbo telpu no savām programmām ar atslēgām, kas redz tikai to, ko izvēlaties.
  • Augšupielādējiet un lejupielādējiet tieši starp savu kodu un krātuves pakalpojumu sniedzēju.
  • Reaģējiet uz jauniem failiem, augšupielādēm failu pieprasījumos un aktivitāti ar trigeriem.

Pirms sākat

Jums vajadzīgs Nubbo konts ar Pro vai Komandas plānu un terminālis ar curl. Komandā API atslēgas izveido īpašnieks vai administrators.

1. solis: izveidojiet atslēgu

  1. Nubbo atveriet Iestatījumi › API (vai Komanda › API komandā) un nospiediet Izveidot API atslēgu.

  2. Piešķiriet tai nosaukumu un izvēlieties:

    • Piekļuve: Tikai lasīšana vai Lasīšana un rakstīšana.
    • Tvērums: Visa telpa vai Izvēlētie bucket un projekti. Atslēga redz tikai to, ko šeit izvēlaties.
    • Derīguma termiņš: 30 dienas, 90 dienas, 1 gads vai Bez derīguma termiņa. Nubbo jūs brīdina 7 dienas iepriekš.

    Nospiediet Izveidot atslēgu. Nubbo prasa jūsu paroli, lai apstiprinātu, ka tas esat jūs. Ja izmantojat divpakāpju verifikāciju, Nubbo prasa arī kodu.

    Logs Izveidot API atslēgu ar piekļuvi, tvērumu un derīguma termiņu Logs Izveidot API atslēgu ar piekļuvi, tvērumu un derīguma termiņu
  3. Nokopējiet atslēgu un nospiediet Atslēga saglabāta. Tā sākas ar nbk_, un šī ir vienīgā reize, kad to redzēsiet pilnībā. Glabājiet to serverī vai rīkā, kas to izmantos, nekad tīmekļa lapā.

    Logs Jūsu API atslēga ar atslēgu, kas gatava kopēšanai Logs Jūsu API atslēga ar atslēgu, kas gatava kopēšanai

2. solis: pirmais pieprasījums

Sūtiet atslēgu katra pieprasījuma galvenē Authorization. Sāciet ar GET /v1/me, kas netērē pieprasījumus:

curl https://api.nubbo.app/v1/me \
  -H "Authorization: Bearer nbk_jusu_atslega"

Atbildē ir jūsu telpa, plāns, mēneša kvota un atslēga ar tās piekļuvi un tvērumu. Lūk, fragments:

{
  "workspace": { "id": "…", "name": "Ziemeļu studija", "kind": "PERSONAL" },
  "plan": "PRO",
  "key": {
    "name": "Mana pirmā atslēga",
    "prefix": "nbk_3jKF3m",
    "access": "READ",
    "allResources": true
  },
  "quota": {
    "requests": { "used": 0, "limit": 50000, "remaining": 50000 },
    "events": { "used": 0, "limit": 20000, "remaining": 20000 },
    "ratePerMinute": 60
  }
}

Pēc tam iegūstiet savu bucket un vienas mapes failu sarakstu:

curl https://api.nubbo.app/v1/buckets \
  -H "Authorization: Bearer nbk_jusu_atslega"

curl "https://api.nubbo.app/v1/buckets/<bucketId>/files?prefix=rekini/" \
  -H "Authorization: Bearer nbk_jusu_atslega"

Saraksti atgriež data un nextCursor. Nākamajai lapai sūtiet šo vērtību laukā cursor. Kad nextCursor ir null, vairāk nekā nav.

Terminālis ar pieprasījumu GET /v1/me un tā atbildi Terminālis ar pieprasījumu GET /v1/me un tā atbildi

3. solis: dokumentācija

Sadaļā Iestatījumi › API nospiediet Skatīt dokumentāciju vai atveriet api.nubbo.app/v1/docs. Tur ir katrs resurss ar tā laukiem un piemēriem. OpenAPI dokuments ir api.nubbo.app/v1/openapi.json.

Nubbo API dokumentācija ar curl piemēru Nubbo API dokumentācija ar curl piemēru

Augšupielādes un lejupielādes

Faili neiet caur Nubbo. Lai augšupielādētu failu, pieprasiet augšupielādi ar POST /v1/buckets/{bucketId}/uploads, nosūtiet failu uz atgriezto iepriekš parakstīto adresi un pabeidziet ar POST /v1/uploads/{uploadId}/complete. Lai lejupielādētu, pieprasiet saiti ar POST /v1/files/{fileId}/download-link un lejupielādējiet failu no sava pakalpojumu sniedzēja.

Limiti

ProKomandas
Pieprasījumi minūtē vienai atslēgai60120
Pieprasījumi mēnesī50 000100 000 + 10 000 par vietu
Trigeru notikumi mēnesī20 00050 000 + 5 000 par vietu

Kvota pieder telpai un atjaunojas katrā norēķinu periodā. GET /v1/me, trigeru vaicājumi un atbildes 401, 429 un 5xx netiek skaitītas kā pieprasījumi. Katrs trigera piegādātais notikums tiek skaitīts kā notikums. Katrā atbildē ir galvenes X-RateLimit-Remaining un X-Nubbo-Quota-Requests-Remaining, un sadaļā Iestatījumi › API redzat perioda lietojumu.

Perioda API lietojums Nubbo iestatījumos Perioda API lietojums Nubbo iestatījumos

Ja kaut kas neizdodas

  • API_KEY_INVALID, API_KEY_REVOKED vai API_KEY_EXPIRED: atslēga nav derīga, ir atsaukta vai tai beidzies termiņš. Pārbaudiet galveni vai izveidojiet citu atslēgu.
  • API_PLAN_REQUIRED: atslēgas telpai nav API. Tā ir Pro un Komandas plānos.
  • API_KEY_READ_ONLY: atslēga ir tikai lasīšanai. Izveidojiet atslēgu ar Lasīšana un rakstīšana.
  • API_RATE_LIMITED: pārāk daudz pieprasījumu ar šo atslēgu. Pagaidiet Retry-After norādītās sekundes un mēģiniet vēlreiz.
  • API_QUOTA_EXCEEDED: telpa ir izmantojusi mēneša limitu. details.resetsAt norāda, kad tas atjaunosies.

Katrai kļūdai ir requestId. Norādiet to, ja mums rakstāt.

Vairāk par Nubbo API. Lai to izmantotu bez koda rakstīšanas, sekojiet Zapier, n8n vai Make ceļvedim. Lai to izmantotu no sava MI asistenta, skatiet, kā savienot Nubbo ar Claude, ChatGPT vai Cursor.

Biežāk uzdotie jautājumi

Kuros plānos ir API?

Pro un Komandas. Ar Bezmaksas vai Personal plānu pieprasījumi atbild ar API_PLAN_REQUIRED.

Vai varu lasīt šifrētus failus ar API?

Nē. Šifrētais saturs tiek rādīts bez nosaukuma, ceļa, izmēra un tipa, un jebkuras tā izmaiņas tiek noraidītas ar API_ENCRYPTED_CONTENT.

Kas notiek, ja atkārtoju pieprasījumu tīkla kļūdas dēļ?

Sūtiet galveni Idempotency-Key savos POST un PATCH pieprasījumos. 24 stundas tā paša pieprasījuma atkārtošana atgriež pirmo atbildi un neko neizveido divreiz.

Vai API mainīsies bez brīdinājuma?

Nē. Nesaderīgas izmaiņas nāk kā /v2, un /v1 paliek vismaz 12 mēnešus ar galvenēm Deprecation un Sunset.

Avoti

Soļi pārbaudīti pēc šīm lapām.