Guider

Kom igång med Nubbos API

Från noll till din första förfrågan på några minuter. Skapa en nyckel och börja hantera din lagring från din egen kod.

Nubbos API är ett REST-API för att arbeta med dina buckets från din egen kod: filer, mappar, länkar, filförfrågningar, gallerier, etiketter, projekt och automatiseringar. I den här guiden skapar du en nyckel och gör dina första begäranden med curl.

Vad du får

  • Hantera ditt Nubbo-utrymme från dina program, med nycklar som bara ser det du väljer.
  • Ladda upp och ner direkt mellan din kod och din lagringsleverantör.
  • Reagera på nya filer, uppladdningar till filförfrågningar och aktivitet med utlösarna.

Innan du börjar

Du behöver ett Nubbo-konto med planen Pro eller Team och en terminal med curl. I ett team skapas API-nycklar av ägaren eller en administratör.

Steg 1: skapa en nyckel

  1. Öppna Inställningar › API i Nubbo (eller Team › API i ett team) och tryck på Skapa API-nyckel.

  2. Ge den ett namn och välj:

    • Åtkomst: Endast läsning eller Läsning och skrivning.
    • Omfång: Hela utrymmet eller Valda buckets och projekt. Nyckeln ser bara det du väljer här.
    • Giltighet: 30 dagar, 90 dagar, 1 år eller Går aldrig ut. Nubbo påminner dig 7 dagar innan.

    Tryck på Skapa nyckel. Nubbo ber om ditt lösenord för att bekräfta att det är du. Om du använder tvåfaktorsautentisering ber Nubbo även om koden.

    Fönstret Skapa API-nyckel med åtkomst, omfång och giltighet Fönstret Skapa API-nyckel med åtkomst, omfång och giltighet
  3. Kopiera nyckeln och tryck på Jag har sparat den. Den börjar med nbk_ och det här är enda gången du ser hela nyckeln. Förvara den på servern eller i verktyget som ska använda den, aldrig på en webbsida.

    Fönstret Din API-nyckel med nyckeln redo att kopieras Fönstret Din API-nyckel med nyckeln redo att kopieras

Steg 2: din första begäran

Skicka nyckeln i headern Authorization i varje begäran. Börja med GET /v1/me, som inte förbrukar några begäranden:

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

Svaret innehåller ditt utrymme, din plan, månadens kvot och nyckeln med dess åtkomst och omfång. Det här är ett utdrag:

{
  "workspace": { "id": "…", "name": "Studio Norr", "kind": "PERSONAL" },
  "plan": "PRO",
  "key": {
    "name": "Min första nyckel",
    "prefix": "nbk_3jKF3m",
    "access": "READ",
    "allResources": true
  },
  "quota": {
    "requests": { "used": 0, "limit": 50000, "remaining": 50000 },
    "events": { "used": 0, "limit": 20000, "remaining": 20000 },
    "ratePerMinute": 60
  }
}

Lista sedan dina buckets och filerna i en mapp:

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

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

Listor returnerar data och nextCursor. För nästa sida skickar du det värdet i cursor. När nextCursor är null finns det inget mer.

Terminal med begäran GET /v1/me och dess svar Terminal med begäran GET /v1/me och dess svar

Steg 3: referensen

I Inställningar › API trycker du på Visa dokumentation, eller öppna api.nubbo.app/v1/docs. Där finns varje resurs med sina fält och exempel. OpenAPI-dokumentet finns på api.nubbo.app/v1/openapi.json.

Referensen för Nubbos API med curl-exemplet Referensen för Nubbos API med curl-exemplet

Uppladdningar och nedladdningar

Filerna passerar inte genom Nubbo. För att ladda upp en fil startar du uppladdningen med POST /v1/buckets/{bucketId}/uploads, skickar filen till den förhandssignerade adressen du får tillbaka och avslutar med POST /v1/uploads/{uploadId}/complete. För att ladda ner ber du om en länk med POST /v1/files/{fileId}/download-link och laddar ner filen från din leverantör.

Gränser

ProTeam
Begäranden per minut per nyckel60120
Begäranden per månad50 000100 000 + 10 000 per licens
Utlösarhändelser per månad20 00050 000 + 5 000 per licens

Kvoten tillhör utrymmet och nollställs med varje faktureringsperiod. GET /v1/me, utlösarnas kontroller och svar med 401, 429 och 5xx räknas inte som begäranden. Varje händelse som en utlösare levererar räknas som en utlösarhändelse. Varje svar innehåller headrarna X-RateLimit-Remaining och X-Nubbo-Quota-Requests-Remaining, och i Inställningar › API ser du periodens användning.

Periodens API-användning i Nubbos inställningar Periodens API-användning i Nubbos inställningar

Om något går fel

  • API_KEY_INVALID, API_KEY_REVOKED eller API_KEY_EXPIRED: nyckeln är ogiltig, har återkallats eller har gått ut. Kontrollera headern eller skapa en ny nyckel.
  • API_PLAN_REQUIRED: nyckelns utrymme har inte API:t. Det ingår i planerna Pro och Team.
  • API_KEY_READ_ONLY: nyckeln är endast för läsning. Skapa en med Läsning och skrivning.
  • API_RATE_LIMITED: för många begäranden med den här nyckeln. Vänta så många sekunder som står i Retry-After och försök igen.
  • API_QUOTA_EXCEEDED: utrymmet har använt sin månadsgräns. details.resetsAt anger när den nollställs.

Varje fel innehåller ett requestId. Ta med det om du skriver till oss.

Mer om Nubbos API. För att använda det utan att skriva kod, följ guiden för Zapier, n8n eller Make. För att använda det från din AI-assistent, se hur du kopplar Nubbo till Claude, ChatGPT eller Cursor.

Vanliga frågor

Vilka planer har API:t?

Pro och Team. Med Gratis eller Personal svarar begäranden API_PLAN_REQUIRED.

Kan jag läsa krypterade filer med API:t?

Nej. Krypterade objekt visas utan namn, sökväg, storlek och typ, och varje ändring av dem avvisas med API_ENCRYPTED_CONTENT.

Vad händer om jag upprepar en begäran efter ett nätverksfel?

Skicka headern Idempotency-Key i dina POST- och PATCH-begäranden. I 24 timmar returnerar samma begäran det första svaret och inget skapas två gånger.

Ändras API:t utan förvarning?

Nej. En ändring som bryter något kommer som /v2, och /v1 finns kvar i minst 12 månader med headrarna Deprecation och Sunset.

Källor

Stegen är kontrollerade mot de här sidorna.