Guider

Kom i gang med Nubbos API

Fra nul til din første forespørgsel på få minutter. Opret en nøgle, og begynd at styre dit lager fra din egen kode.

Nubbos API er et REST API til at arbejde med dine buckets fra din egen kode: filer, mapper, links, filanmodninger, gallerier, labels, projekter og automatiseringer. I denne guide opretter du en nøgle og sender dine første anmodninger med curl.

Det får du

  • Administrer dit Nubbo-område fra dine programmer med nøgler, der kun ser det, du vælger.
  • Upload og download direkte mellem din kode og din lagerudbyder.
  • Reager på nye filer, uploads til filanmodninger og aktivitet med triggerne.

Før du går i gang

Du skal have en Nubbo-konto med planen Pro eller Teams og en terminal med curl. I et team er det ejeren eller en administrator, der opretter API-nøglerne.

Trin 1: opret en nøgle

  1. Åbn Indstillinger › API i Nubbo (eller Team › API i et team), og tryk på Opret API-nøgle.

  2. Giv den et navn, og vælg:

    • Adgang: Kun læsning eller Læsning og skrivning.
    • Omfang: Hele området eller Valgte buckets og projekter. Nøglen ser kun det, du vælger her.
    • Udløb: 30 dage, 90 dage, 1 år eller Udløber aldrig. Nubbo minder dig om det 7 dage før.

    Tryk på Opret nøgle. Nubbo beder om din adgangskode for at bekræfte, at det er dig. Har du slået totrinsbekræftelse til, beder den også om koden.

    Vinduet Opret API-nøgle med adgang, omfang og udløb Vinduet Opret API-nøgle med adgang, omfang og udløb
  3. Kopiér nøglen, og tryk på Jeg har gemt den. Den starter med nbk_, og det er den eneste gang, du ser den i sin helhed. Gem den på serveren eller i det værktøj, der skal bruge den, aldrig på en webside.

    Vinduet Din API-nøgle med nøglen klar til at kopiere Vinduet Din API-nøgle med nøglen klar til at kopiere

Trin 2: din første anmodning

Send nøglen i headeren Authorization i hver anmodning. Start med GET /v1/me, som ikke bruger nogen anmodninger:

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

Svaret indeholder dit område, din plan, månedens kvote og nøglen med dens adgang og omfang. Her er et uddrag:

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

Vis derefter dine buckets og filerne i en mappe:

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

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

Lister returnerer data og nextCursor. For den næste side sender du den værdi i cursor. Når nextCursor er null, er der ikke mere.

Terminal med anmodningen GET /v1/me og dens svar Terminal med anmodningen GET /v1/me og dens svar

Trin 3: referencen

Tryk på Se dokumentation i Indstillinger › API, eller åbn api.nubbo.app/v1/docs. Der finder du hver ressource med dens felter og eksempler. OpenAPI-dokumentet ligger på api.nubbo.app/v1/openapi.json.

Referencen for Nubbos API med curl-eksemplet Referencen for Nubbos API med curl-eksemplet

Uploads og downloads

Filer går ikke gennem Nubbo. For at uploade en fil starter du uploaden med POST /v1/buckets/{bucketId}/uploads, sender filen til den forhåndssignerede adresse, du får tilbage, og afslutter med POST /v1/uploads/{uploadId}/complete. For at downloade beder du om et link med POST /v1/files/{fileId}/download-link og downloader filen fra din udbyder.

Grænser

ProTeams
Anmodninger pr. minut pr. nøgle60120
Anmodninger pr. måned50.000100.000 + 10.000 pr. plads
Trigger-hændelser pr. måned20.00050.000 + 5.000 pr. plads

Kvoten hører til området og nulstilles med hver faktureringsperiode. GET /v1/me, triggernes forespørgsler og svar med 401, 429 og 5xx tæller ikke som anmodninger. Hver hændelse, en trigger leverer, tæller som en trigger-hændelse. Hvert svar indeholder headerne X-RateLimit-Remaining og X-Nubbo-Quota-Requests-Remaining, og i Indstillinger › API ser du periodens forbrug.

Periodens API-forbrug i Nubbos indstillinger Periodens API-forbrug i Nubbos indstillinger

Hvis noget går galt

  • API_KEY_INVALID, API_KEY_REVOKED eller API_KEY_EXPIRED: nøglen er ugyldig, tilbagekaldt eller udløbet. Tjek headeren, eller opret en ny nøgle.
  • API_PLAN_REQUIRED: nøglens område har ikke API’et. Det følger med planerne Pro og Teams.
  • API_KEY_READ_ONLY: nøglen kan kun læse. Opret en med Læsning og skrivning.
  • API_RATE_LIMITED: for mange anmodninger med denne nøgle. Vent de sekunder, der står i Retry-After, og prøv igen.
  • API_QUOTA_EXCEEDED: området har brugt sin månedlige grænse. details.resetsAt viser, hvornår den nulstilles.

Hver fejl indeholder et requestId. Medtag det, hvis du skriver til os.

Mere om Nubbos API. Vil du bruge det uden at skrive kode, så følg guiden til Zapier, til n8n eller til Make. Vil du bruge det fra din AI-assistent, så se, hvordan du forbinder Nubbo med Claude, ChatGPT eller Cursor.

Ofte stillede spørgsmål

Hvilke planer indeholder API'et?

Pro og Teams. Med Gratis eller Personal svarer anmodningerne med API_PLAN_REQUIRED.

Kan jeg læse krypterede filer med API'et?

Nej. Krypteret indhold vises uden navn, sti, størrelse og type, og enhver ændring af det afvises med API_ENCRYPTED_CONTENT.

Hvad sker der, hvis jeg gentager en anmodning efter en netværksfejl?

Send headeren Idempotency-Key med dine POST- og PATCH-anmodninger. I 24 timer giver den samme anmodning det første svar igen og opretter intet to gange.

Ændrer API'et sig uden varsel?

Nej. En ændring, der bryder bagudkompatibiliteten, kommer som /v2, og /v1 bliver i mindst 12 måneder med headerne Deprecation og Sunset.

Kilder

Trinene er tjekket mod disse sider.