Juhendid

Alusta Nubbo API-ga

Nullist esimese päringuni mõne minutiga. Loo võti ja hakka oma salvestust oma koodist haldama.

Nubbo API on REST API, millega töötad oma bucketitega oma koodist: failid, kaustad, lingid, failipäringud, galeriid, sildid, projektid ja automatiseeringud. Selles juhendis lood võtme ja saadad curliga oma esimesed päringud.

Mida sa saad

  • Halda oma Nubbo ruumi oma programmidest, võtmetega, mis näevad ainult seda, mida sina valid.
  • Laadi faile üles ja alla otse oma koodi ja salvestusteenuse pakkuja vahel.
  • Reageeri päästikutega uutele failidele, failipäringutesse üleslaadimistele ja tegevusele.

Enne alustamist

Vajad Nubbo kontot paketiga Pro või Meeskonnad ja terminali, kus on curl. Meeskonnas loovad API-võtmeid omanik või administraator.

1. samm: loo võti

  1. Ava Nubbos Seaded › API (või meeskonnas Meeskond › API) ja vajuta Loo API-võti.

  2. Anna sellele nimi ja vali:

    • Juurdepääs: Ainult lugemine või Lugemine ja kirjutamine.
    • Ulatus: Kogu ruum või Valitud bucketid ja projektid. Võti näeb ainult seda, mille siin valid.
    • Aegumine: 30 päeva, 90 päeva, 1 aasta või Ei aegu. Nubbo tuletab sulle 7 päeva varem meelde.

    Vajuta Loo võti. Nubbo küsib sinu parooli, et kinnitada, et see oled sina. Kui sul on kaheastmeline kinnitamine sisse lülitatud, küsib Nubbo ka koodi.

    Aken Loo API-võti juurdepääsu, ulatuse ja aegumisega Aken Loo API-võti juurdepääsu, ulatuse ja aegumisega
  3. Kopeeri võti ja vajuta Salvestasin selle. See algab tähtedega nbk_ ja ainult praegu näed seda tervikuna. Hoia seda serveris või tööriistas, mis seda kasutab, mitte kunagi veebilehel.

    Aken Sinu API-võti, kus võti on kopeerimiseks valmis Aken Sinu API-võti, kus võti on kopeerimiseks valmis

2. samm: sinu esimene päring

Saada võti iga päringu päises Authorization. Alusta päringust GET /v1/me, mis ei kuluta päringuid:

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

Vastuses on sinu ruum, sinu pakett, kuu kvoot ja võti koos juurdepääsu ja ulatusega. See on väljavõte:

{
  "workspace": { "id": "…", "name": "Stuudio Põhi", "kind": "PERSONAL" },
  "plan": "PRO",
  "key": {
    "name": "Minu esimene võti",
    "prefix": "nbk_3jKF3m",
    "access": "READ",
    "allResources": true
  },
  "quota": {
    "requests": { "used": 0, "limit": 50000, "remaining": 50000 },
    "events": { "used": 0, "limit": 20000, "remaining": 20000 },
    "ratePerMinute": 60
  }
}

Seejärel kuva oma bucketid ja kausta failid:

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

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

Loendid tagastavad data ja nextCursor. Järgmise lehe jaoks saada see väärtus väljal cursor. Kui nextCursor on null, rohkem pole.

Terminal päringuga GET /v1/me ja selle vastusega Terminal päringuga GET /v1/me ja selle vastusega

3. samm: viitedokumentatsioon

Vajuta jaotises Seaded › API nuppu Vaata dokumentatsiooni või ava api.nubbo.app/v1/docs. Seal on iga ressurss koos väljade ja näidetega. OpenAPI dokument on aadressil api.nubbo.app/v1/openapi.json.

Nubbo API viitedokumentatsioon curli näitega Nubbo API viitedokumentatsioon curli näitega

Üles- ja allalaadimised

Failid ei liigu läbi Nubbo. Faili üleslaadimiseks alusta üleslaadimist päringuga POST /v1/buckets/{bucketId}/uploads, saada fail eelallkirjastatud aadressile, mille saad vastuseks, ja lõpeta päringuga POST /v1/uploads/{uploadId}/complete. Allalaadimiseks küsi link päringuga POST /v1/files/{fileId}/download-link ja laadi fail alla oma teenusepakkujalt.

Limiidid

ProMeeskonnad
Päringuid minutis võtme kohta60120
Päringuid kuus50 000100 000 + 10 000 koha kohta
Päästikute sündmusi kuus20 00050 000 + 5 000 koha kohta

Kvoot kuulub ruumile ja uueneb iga arveldusperioodiga. GET /v1/me, päästikute päringud ning vastused 401, 429 ja 5xx ei lähe päringutena arvesse. Iga sündmus, mille päästik edastab, loetakse päästiku sündmuseks. Igas vastuses on päised X-RateLimit-Remaining ja X-Nubbo-Quota-Requests-Remaining ning jaotises Seaded › API näed perioodi kasutust.

Perioodi API kasutus Nubbo seadetes Perioodi API kasutus Nubbo seadetes

Kui midagi ei tööta

  • API_KEY_INVALID, API_KEY_REVOKED või API_KEY_EXPIRED: võti ei kehti, on tühistatud või aegunud. Kontrolli päist või loo uus võti.
  • API_PLAN_REQUIRED: võtme ruumil pole API-t. See kuulub pakettidesse Pro ja Meeskonnad.
  • API_KEY_READ_ONLY: võti on ainult lugemiseks. Loo võti juurdepääsuga Lugemine ja kirjutamine.
  • API_RATE_LIMITED: selle võtmega on liiga palju päringuid. Oota Retry-After sekundid ära ja proovi uuesti.
  • API_QUOTA_EXCEEDED: ruum on kuu limiidi ära kasutanud. details.resetsAt ütleb, millal see uueneb.

Igas veas on requestId. Lisa see, kui meile kirjutad.

Rohkem teavet: Nubbo API. Et seda ilma koodita kasutada, järgi Zapieri, n8n-i või Make’i juhendit. Et seda oma tehisintellekti assistendist kasutada, vaata, kuidas ühendada Nubbo Claude’i, ChatGPT või Cursoriga.

Korduma kippuvad küsimused

Millised paketid sisaldavad API-t?

Pro ja Meeskonnad. Paketiga Tasuta või Personal vastavad päringud koodiga API_PLAN_REQUIRED.

Kas ma saan API kaudu krüpteeritud faile lugeda?

Ei. Krüpteeritud sisu kuvatakse ilma nime, tee, suuruse ja tüübita ning iga muudatus selles lükatakse tagasi koodiga API_ENCRYPTED_CONTENT.

Mis juhtub, kui kordan päringut pärast võrgutõrget?

Saada POST- ja PATCH-päringutega päis Idempotency-Key. 24 tunni jooksul tagastab sama päringu kordamine esimese vastuse ega loo midagi kaks korda.

Kas API muutub ilma hoiatuseta?

Ei. Ühildumatu muudatus tuleb versioonina /v2 ja /v1 jääb alles vähemalt 12 kuuks koos päistega Deprecation ja Sunset.

Allikad

Sammud on kontrollitud nende lehtede põhjal.