Oppaat

Aloita Nubbon API:n käyttö

Nollasta ensimmäiseen pyyntöön muutamassa minuutissa. Luo avain ja ala hallita tallennustasi omasta koodistasi.

Nubbon API on REST-rajapinta, jolla käsittelet bucketejasi omasta koodistasi: tiedostot, kansiot, linkit, tiedostopyynnöt, galleriat, tunnisteet, projektit ja automaatiot. Tässä oppaassa luot avaimen ja lähetät ensimmäiset pyyntösi curlilla.

Mitä saat

  • Hallitse Nubbo-tilaasi ohjelmistasi avaimilla, jotka näkevät vain sen, minkä valitset.
  • Lähetä ja lataa tiedostoja suoraan koodisi ja tallennuspalvelusi välillä.
  • Reagoi uusiin tiedostoihin, tiedostopyyntöihin tehtyihin lähetyksiin ja toimintaan triggereillä.

Ennen kuin aloitat

Tarvitset Nubbo-tilin, jolla on Pro- tai Tiimit-tilaus, ja päätteen, jossa on curl. Tiimissä API-avaimet luo omistaja tai ylläpitäjä.

Vaihe 1: luo avain

  1. Avaa Nubbossa Asetukset › API (tai tiimissä Tiimi › API) ja paina Luo API-avain.

  2. Anna sille nimi ja valitse:

    • Käyttöoikeus: Vain luku tai Luku ja kirjoitus.
    • Kattavuus: Koko tila tai Valitut bucketit ja projektit. Avain näkee vain sen, mitä valitset tässä.
    • Vanheneminen: 30 päivää, 90 päivää, 1 vuosi tai Ei vanhenemisaikaa. Nubbo muistuttaa sinua 7 päivää etukäteen.

    Paina Luo avain. Nubbo kysyy salasanaasi varmistaakseen, että se olet sinä. Jos kaksivaiheinen vahvistus on käytössä, Nubbo kysyy myös koodin.

    Luo API-avain -ikkuna, jossa ovat käyttöoikeus, kattavuus ja vanheneminen Luo API-avain -ikkuna, jossa ovat käyttöoikeus, kattavuus ja vanheneminen
  3. Kopioi avain ja paina Olen tallentanut sen. Se alkaa merkeillä nbk_, ja näet sen kokonaan vain tämän kerran. Säilytä sitä palvelimella tai työkalussa, joka käyttää sitä, älä koskaan verkkosivulla.

    API-avaimesi-ikkuna, jossa avain on valmiina kopioitavaksi API-avaimesi-ikkuna, jossa avain on valmiina kopioitavaksi

Vaihe 2: ensimmäinen pyyntösi

Lähetä avain jokaisen pyynnön Authorization-otsakkeessa. Aloita pyynnöstä GET /v1/me, joka ei kuluta pyyntöjä:

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

Vastauksessa ovat tilasi, tilauksesi, kuukauden kiintiö ja avain käyttöoikeuksineen ja kattavuuksineen. Tässä ote:

{
  "workspace": { "id": "…", "name": "Studio Pohjoinen", "kind": "PERSONAL" },
  "plan": "PRO",
  "key": {
    "name": "Ensimmäinen avaimeni",
    "prefix": "nbk_3jKF3m",
    "access": "READ",
    "allResources": true
  },
  "quota": {
    "requests": { "used": 0, "limit": 50000, "remaining": 50000 },
    "events": { "used": 0, "limit": 20000, "remaining": 20000 },
    "ratePerMinute": 60
  }
}

Listaa sitten bucketisi ja kansion tiedostot:

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

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

Listat palauttavat data ja nextCursor. Seuraavaa sivua varten lähetä tämä arvo kentässä cursor. Kun nextCursor on null, enempää ei ole.

Pääte, jossa on GET /v1/me -pyyntö ja sen vastaus Pääte, jossa on GET /v1/me -pyyntö ja sen vastaus

Vaihe 3: viiteohjeet

Paina kohdassa Asetukset › API Katso ohjeet tai avaa api.nubbo.app/v1/docs. Siellä on jokainen resurssi kenttineen ja esimerkkeineen. OpenAPI-dokumentti on osoitteessa api.nubbo.app/v1/openapi.json.

Nubbon API:n viiteohjeet curl-esimerkin kanssa Nubbon API:n viiteohjeet curl-esimerkin kanssa

Lähetykset ja lataukset

Tiedostot eivät kulje Nubbon kautta. Lähettääksesi tiedoston aloita lähetys pyynnöllä POST /v1/buckets/{bucketId}/uploads, lähetä tiedosto palautettuun esiallekirjoitettuun osoitteeseen ja viimeistele pyynnöllä POST /v1/uploads/{uploadId}/complete. Ladataksesi pyydä linkki pyynnöllä POST /v1/files/{fileId}/download-link ja lataa tiedosto palveluntarjoajaltasi.

Rajat

ProTiimit
Pyyntöjä minuutissa avainta kohden60120
Pyyntöjä kuukaudessa50 000100 000 + 10 000 paikkaa kohden
Trigger-tapahtumia kuukaudessa20 00050 000 + 5 000 paikkaa kohden

Kiintiö kuuluu tilalle ja uusiutuu jokaisella laskutusjaksolla. GET /v1/me, triggerien kyselyt sekä vastaukset 401, 429 ja 5xx eivät lasketa pyynnöiksi. Jokainen triggerin toimittama tapahtuma lasketaan trigger-tapahtumaksi. Jokaisessa vastauksessa ovat otsakkeet X-RateLimit-Remaining ja X-Nubbo-Quota-Requests-Remaining, ja kohdassa Asetukset › API näet jakson käytön.

Jakson API-käyttö Nubbon asetuksissa Jakson API-käyttö Nubbon asetuksissa

Jos jokin ei toimi

  • API_KEY_INVALID, API_KEY_REVOKED tai API_KEY_EXPIRED: avain ei ole voimassa, se on peruttu tai vanhentunut. Tarkista otsake tai luo uusi avain.
  • API_PLAN_REQUIRED: avaimen tilassa ei ole API:a. Se sisältyy Pro- ja Tiimit-tilauksiin.
  • API_KEY_READ_ONLY: avain on vain lukua varten. Luo avain, jolla on Luku ja kirjoitus.
  • API_RATE_LIMITED: liian monta pyyntöä tällä avaimella. Odota Retry-After-otsakkeen sekunnit ja yritä uudelleen.
  • API_QUOTA_EXCEEDED: tila on käyttänyt kuukausirajansa. details.resetsAt kertoo, milloin se uusiutuu.

Jokaisessa virheessä on requestId. Liitä se mukaan, jos kirjoitat meille.

Lisää tietoa: Nubbon API. Jos haluat käyttää sitä ilman koodia, seuraa Zapierin, n8n:n tai Maken opasta. Jos haluat käyttää sitä tekoälyavustajastasi, katso, miten yhdistät Nubbon Claudeen, ChatGPT:hen tai Cursoriin.

Usein kysytyt kysymykset

Mitkä tilaukset sisältävät API:n?

Pro ja Tiimit. Ilmainen- tai Personal-tilauksella pyynnöt vastaavat API_PLAN_REQUIRED.

Voinko lukea salattuja tiedostoja API:lla?

Et. Salattu sisältö näkyy ilman nimeä, polkua, kokoa ja tyyppiä, ja kaikki siihen tehtävät muutokset hylätään koodilla API_ENCRYPTED_CONTENT.

Mitä tapahtuu, jos toistan pyynnön verkkovirheen jälkeen?

Lähetä Idempotency-Key-otsake POST- ja PATCH-pyynnöissä. 24 tunnin ajan saman pyynnön toistaminen palauttaa ensimmäisen vastauksen eikä luo mitään kahdesti.

Muuttuuko API ilman ennakkovaroitusta?

Ei. Yhteensopimaton muutos julkaistaan versiona /v2, ja /v1 säilyy vähintään 12 kuukautta Deprecation- ja Sunset-otsakkeiden kanssa.

Lähteet

Vaiheet on tarkistettu näiltä sivuilta.