bgCut.net API

Poista taustoja omissa sovelluksissasi, verkkokaupoissasi tai työnkuluissasi yhdellä HTTPS-pyynnöllä.

Perus-URL: https://bgcut.net/api/v1 · Hae avaimesi kohdasta API-avaimet.

Todennus

Jokaisen pyynnön X-Api-Key-otsakkeessa on oltava API-avaimesi. Avaimet luodaan ja mitätöidään tililläsi. Jokaisen avaimen voi nimetä, joten voit vaihtaa avaimia sovelluskohtaisesti.

X-Api-Key: bgc_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Vaihtoehtoisesti voit lähettää sen Bearer-tunnisteena: Authorization: Bearer bgc_…

POST /remove

Lähetä kuva multipart-tiedostona, URL-osoitteena tai base64-koodattuna. Vastauksena palautetaan oletuksena tuloskuva (binäärinä).

Parametrit

ParametriTyyppiKuvaus
image_filefileKuvatiedosto (multipart/form-data). JPG, PNG, WebP, GIF, BMP, TIFF; enintään 25 Mt / 30 MP.
image_urlstringKuvan julkinen URL-osoite, josta kuva haetaan latauksen sijaan.
image_file_b64stringBase64-koodattu kuva (valinnaisesti data:-etuliitteellä).
sizeauto | preview | fullpreview = enintään 640 px (käyttää ilmaista kuukausikiintiötä, ei krediittejä); full = alkuperäinen resoluutio (1 krediitti); auto (oletus) = full, jos sinulla on krediittejä, muuten preview.
formatpng | jpg | webpTulostusmuoto. png säilyttää läpinäkyvyyden; jpg yhdistetään bg_color-väriin (oletuksena valkoinen).
modelfast | hq | portraitlite (oletus, n. 6 s, paras tasapaino), fast (n. 0,5 s, esikatselulaatu), hq (n. 15 s, paras laatu), portrait (n. 0,3 s, vain ihmiset).
bg_colorstringTaustan heksaväri, esim. #ffffff. Jätä pois, jos haluat läpinäkyvän taustan.
bg_blurnumberSäilyttää alkuperäisen taustan mutta sumentaa sen annetulla säteellä pikseleinä (1–200), esim. 25 muotokuvatilan tyyliin. Ohittaa bg_color-arvon.
cropbooleanRajaa tuloskuvan kohteen rajausruutuun.
crop_marginintegerLisämarginaali pikseleinä kohteen ympärillä rajattaessa (0–200).
roistringKiinnostava alue murtolukuina x,y,w,h (0–1). Tekoäly käsittelee vain tämän suorakulmion sisäpuolen; kaikki sen ulkopuolella muuttuu läpinäkyväksi.
feathernumberPehmentää reunoja annetulla säteellä pikseleinä (0–5).
qualityintegerJPG/WebP-laatu 50–100 (oletus 92).
responsebinary | jsonbinary (oletus) palauttaa kuvan; json palauttaa metatiedot ja base64-kuvan.

Vastaukset

Onnistuneet pyynnöt palauttavat HTTP 200 -tilan, kuvan tavut ja seuraavat otsakkeet:

HTTP/1.1 200 OK
Content-Type: image/png
X-Credits-Charged: 1
X-Credits-Remaining: 149
X-Free-Remaining: 5
X-Width: 3000
X-Height: 2000
X-Image-Id: 1f3a…
X-Type: hd

Parametrilla response=json saat:

{
  "ok": true,
  "image": { "id": "1f3a…", "width": 3000, "height": 2000, "format": "png", "type": "hd", "bytes": 812345, "bbox": [120, 40, 2810, 1990], "data": "iVBORw0KGgo…" },
  "credits_charged": 1,
  "credits_remaining": 149,
  "free_remaining": 5
}

GET /account

curl https://bgcut.net/api/v1/account -H "X-Api-Key: bgc_…"

{ "ok": true, "email": "[email protected]", "credits": 149, "free_remaining": 5, "free_per_month": 5, "free_max_width": 640, "rate_limit_per_minute": 60 }

GET /images

Palauttaa 100 viimeisintä API-avaimillasi käsiteltyä kuvaa sekä editorin URL-osoitteen, jolla voit viimeistellä niitä selaimessa.

Virheet

Virheet palautetaan JSON-muodossa, joka sisältää virhekoodin ja selkokielisen viestin:

{ "ok": false, "error": "insufficient_credits", "message": "No credits left. Buy credits at https://bgcut.net/pricing or request size=preview." }
HTTPerrorKuvaus
400bad_request / missing_imagePuuttuvia tai virheellisiä parametreja.
401auth_required / invalid_keyAPI-avain puuttuu, on virheellinen tai mitätöity.
402insufficient_credits / free_quota_exceededEi krediittejä (täysi koko) tai ilmainen kiintiö on käytetty (esikatselu).
422too_large / bad_type / fetch_failedKuvaa ei voitu lukea tai ladata.
429rate_limitedLiian monta pyyntöä – hidasta tahtia tai pyydä meiltä korkeampia rajoja.
500processing_failedKäsittely epäonnistui meidän päässämme – sinua ei veloiteta.

Esimerkkikoodi

Kaikki esimerkit käyttävät samaa päätepistettä. Lataa koko esimerkkikokoelma: bgcut-api-examples.zip

Virallinen PHP SDK
Avoimen lähdekoodin asiakaskirjasto, jossa on tyypitetyt tulokset, virheluokat ja käyttövalmiit esimerkit. MIT-lisenssi.
composer require bgcut-net/bgcut-php
GitHub

Rajoitukset

  • 60 pyyntöä minuutissa API-avainta kohden (korkeammat rajat pyynnöstä).
  • Enintään 25 Mt ja 30 megapikseliä kuvaa kohden; suuremmat kuvat pienennetään.
  • Käsiteltyjä kuvia säilytetään 30 päivää, ja niitä voi viimeistellä verkkoeditorissa.
  • Epäonnistuneista pyynnöistä ei koskaan veloiteta; veloitus palautetaan automaattisesti, jos tuloskuvan luonti epäonnistuu.

Aloita integrointi

Luo ilmainen tili, luo avain ja tee ensimmäinen kutsusi alle minuutissa.

Hanki API-avain Hinnoittelu