Veiledninger

Kom i gang med API-et til Nubbo

Fra null til din første forespørsel på noen minutter. Opprett en nøkkel og begynn å styre lagringen din fra din egen kode.

API-et til Nubbo er et REST-API for å jobbe med bucketene dine fra din egen kode: filer, mapper, lenker, filforespørsler, gallerier, etiketter, prosjekter og automatiseringer. I denne veiledningen oppretter du en nøkkel og sender de første forespørslene med curl.

Dette får du

  • Administrere Nubbo-området ditt fra programmene dine, med nøkler som bare ser det du velger.
  • Laste opp og ned direkte mellom koden din og lagringsleverandøren din.
  • Reagere på nye filer, opplastinger til filforespørsler og aktivitet med utløserne.

Før du begynner

Du trenger en Nubbo-konto med Pro- eller Team-abonnementet og en terminal med curl. I et team er det eieren eller en administrator som oppretter API-nøklene.

Steg 1: opprett en nøkkel

  1. I Nubbo åpner du Innstillinger › API (eller Team › API i et team) og trykker på Opprett API-nøkkel.

  2. Gi den et navn og velg:

    • Tilgang: Kun lesing eller Lesing og skriving.
    • Omfang: Hele området eller Valgte buckets og prosjekter. Nøkkelen ser bare det du velger her.
    • Utløp: 30 dager, 90 dager, 1 år eller Utløper aldri. Nubbo varsler deg 7 dager før.

    Trykk på Opprett nøkkel. Nubbo ber om passordet ditt for å bekrefte at det er deg. Med totrinnsbekreftelse på ber Nubbo også om koden.

    Vinduet Opprett API-nøkkel med tilgang, omfang og utløp Vinduet Opprett API-nøkkel med tilgang, omfang og utløp
  3. Kopier nøkkelen og trykk på Jeg har lagret den. Den begynner med nbk_, og dette er den eneste gangen du ser hele nøkkelen. Lagre den på serveren eller i verktøyet som skal bruke den, aldri på en nettside.

    Vinduet API-nøkkelen din med nøkkelen klar til å kopieres Vinduet API-nøkkelen din med nøkkelen klar til å kopieres

Steg 2: din første forespørsel

Send nøkkelen i headeren Authorization i hver forespørsel. Begynn med GET /v1/me, som ikke bruker forespørsler:

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

Svaret viser området ditt, abonnementet ditt, månedens kvote og nøkkelen med tilgang og omfang. Dette er et utdrag:

{
  "workspace": { "id": "…", "name": "Studio Nord", "kind": "PERSONAL" },
  "plan": "PRO",
  "key": {
    "name": "Min første nøkkel",
    "prefix": "nbk_3jKF3m",
    "access": "READ",
    "allResources": true
  },
  "quota": {
    "requests": { "used": 0, "limit": 50000, "remaining": 50000 },
    "events": { "used": 0, "limit": 20000, "remaining": 20000 },
    "ratePerMinute": 60
  }
}

Deretter lister du bucketene dine og filene i en mappe:

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

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

Lister gir tilbake data og nextCursor. For neste side sender du den verdien i cursor. Når nextCursor er null, er det ikke mer.

Terminal med forespørselen GET /v1/me og svaret Terminal med forespørselen GET /v1/me og svaret

Steg 3: referansen

I Innstillinger › API trykker du på Se dokumentasjonen, eller åpner api.nubbo.app/v1/docs. Der finner du hver ressurs med feltene og eksempler. OpenAPI-dokumentet ligger på api.nubbo.app/v1/openapi.json.

Referansen til API-et til Nubbo med eksempelet i curl Referansen til API-et til Nubbo med eksempelet i curl

Opplastinger og nedlastinger

Filene går ikke via Nubbo. For å laste opp en fil ber du om opplastingen med POST /v1/buckets/{bucketId}/uploads, sender filen til den forhåndssignerte adressen du får tilbake og avslutter med POST /v1/uploads/{uploadId}/complete. For å laste ned ber du om en lenke med POST /v1/files/{fileId}/download-link og laster ned fra leverandøren din.

Grenser

ProTeam
Forespørsler per minutt per nøkkel60120
Forespørsler per måned50 000100 000 + 10 000 per plass
Utløserhendelser per måned20 00050 000 + 5 000 per plass

Kvoten tilhører området og fornyes hver faktureringsperiode. GET /v1/me, utløsernes spørringer og svarene 401, 429 og 5xx teller ikke som forespørsler. Hver hendelse en utløser leverer, teller som en hendelse. Hvert svar har headerne X-RateLimit-Remaining og X-Nubbo-Quota-Requests-Remaining, og i Innstillinger › API ser du bruken for perioden.

API-bruk for perioden i innstillingene til Nubbo API-bruk for perioden i innstillingene til Nubbo

Hvis noe feiler

  • API_KEY_INVALID, API_KEY_REVOKED eller API_KEY_EXPIRED: nøkkelen er ugyldig, tilbakekalt eller utløpt. Sjekk headeren eller opprett en ny nøkkel.
  • API_PLAN_REQUIRED: området til nøkkelen har ikke API-et. Det finnes i abonnementene Pro og Team.
  • API_KEY_READ_ONLY: nøkkelen er kun for lesing. Opprett en med Lesing og skriving.
  • API_RATE_LIMITED: for mange forespørsler med denne nøkkelen. Vent sekundene i Retry-After og prøv igjen.
  • API_QUOTA_EXCEEDED: området har brukt opp månedens grense. details.resetsAt viser når den fornyes.

Hver feil har en requestId. Ta den med hvis du skriver til oss.

Mer om API-et til Nubbo. For å bruke det uten å skrive kode, følg veiledningen for Zapier, for n8n eller for Make. For å bruke det fra AI-assistenten din, se hvordan du kobler Nubbo til Claude, ChatGPT eller Cursor.

Ofte stilte spørsmål

Hvilke abonnementer har API-et?

Pro og Team. Med Gratis eller Personal svarer forespørslene med API_PLAN_REQUIRED.

Kan jeg lese krypterte filer med API-et?

Nei. Kryptert innhold vises uten navn, sti, størrelse eller type, og alle endringer på det avvises med API_ENCRYPTED_CONTENT.

Hva skjer hvis jeg gjentar en forespørsel etter en nettverksfeil?

Send headeren Idempotency-Key i POST og PATCH. I 24 timer gir samme forespørsel det første svaret tilbake, og ingenting opprettes to ganger.

Endres API-et uten varsel?

Nei. En endring som ødelegger noe, kommer som /v2, og /v1 beholdes i minst 12 måneder, med headerne Deprecation og Sunset.

Kilder

Stegene er sjekket mot disse sidene.