bgCut.net API

Šalinkite fonus savo programose, parduotuvėse ar duomenų srautuose viena HTTPS užklausa.

Bazinis URL: https://bgcut.net/api/v1 · Raktą gausite skiltyje API raktai.

Autentifikavimas

Kiekvienoje užklausoje antraštėje X-Api-Key turi būti nurodytas jūsų API raktas. Raktai kuriami ir atšaukiami jūsų paskyroje. Kiekvienam raktui galite suteikti pavadinimą, kad galėtumėte juos keisti atskirai kiekvienai programai.

X-Api-Key: bgc_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Taip pat galite jį siųsti kaip Bearer prieigos raktą: Authorization: Bearer bgc_…

POST /remove

Siųskite vaizdą kaip multipart failą, URL arba base64 koduote. Pagal numatytuosius nustatymus atsakyme grąžinamas gautas vaizdas (dvejetainis).

Parametrai

ParametrasTipasAprašymas
image_filefileVaizdo failas (multipart/form-data). JPG, PNG, WebP, GIF, BMP, TIFF; daugiausia 25 MB / 30 MP.
image_urlstringViešas vaizdo URL, iš kurio vaizdas atsisiunčiamas vietoj įkėlimo.
image_file_b64stringBase64 koduotės vaizdas (pasirinktinai su data: priešdėliu).
sizeauto | preview | fullpreview – iki 640 px (naudojama nemokama mėnesio kvota, kreditai nenurašomi); full – originali raiška (1 kreditas); auto (numatytasis) – full, jei turite kreditų, kitu atveju preview.
formatpng | jpg | webpIšvesties formatas. png išsaugo skaidrumą; jpg sulieja vaizdą su bg_color spalva (numatytoji – balta).
modelfast | hq | portraitlite (numatytasis, ~6 s, geriausias balansas), fast (~0,5 s, peržiūros kokybė), hq (~15 s, aukščiausia kokybė), portrait (~0,3 s, tik žmonėms).
bg_colorstringFono spalva šešioliktainiu kodu, pvz., #ffffff. Nenurodykite, jei norite skaidraus fono.
bg_blurnumberIšsaugo originalų foną, bet jį sulieja nurodytu spinduliu pikseliais (1–200), pvz., 25 portreto režimo efektui. Turi pirmenybę prieš bg_color.
cropbooleanApkirpti išvestį pagal objekto ribas.
crop_marginintegerPapildoma paraštė pikseliais aplink objektą apkerpant (0–200).
roistringDominanti sritis, nurodyta dalimis x,y,w,h (0–1). DI analizuoja tik šį stačiakampį; viskas už jo ribų tampa skaidru.
feathernumberSušvelninti kraštus nurodytu spinduliu pikseliais (0–5).
qualityintegerJPG/WebP kokybė 50–100 (numatytoji 92).
responsebinary | jsonbinary (numatytasis) grąžina vaizdą; json grąžina metaduomenis ir base64 vaizdą.

Atsakymai

Sėkmingos užklausos grąžina HTTP 200 su vaizdo baitais ir šiomis antraštėmis:

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

Nurodę response=json gausite:

{
  "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

Grąžina paskutinius 100 vaizdų, apdorotų jūsų API raktais, kartu su redaktoriaus URL, kad galėtumėte juos patobulinti naršyklėje.

Klaidos

Klaidos grąžinamos JSON formatu su klaidos kodu ir žmogui suprantamu pranešimu:

{ "ok": false, "error": "insufficient_credits", "message": "No credits left. Buy credits at https://bgcut.net/pricing or request size=preview." }
HTTPerrorAprašymas
400bad_request / missing_imageTrūksta parametrų arba jie neteisingi.
401auth_required / invalid_keyAPI raktas nenurodytas, neteisingas arba atšauktas.
402insufficient_credits / free_quota_exceededNėra kreditų (pilnam dydžiui) arba išnaudota nemokama kvota (peržiūrai).
422too_large / bad_type / fetch_failedNepavyko nuskaityti arba atsisiųsti vaizdo.
429rate_limitedPer daug užklausų – sulėtinkite arba susisiekite su mumis dėl didesnių limitų.
500processing_failedApdoroti nepavyko dėl mūsų klaidos – mokestis nenuskaičiuojamas.

Kodo pavyzdžiai

Visuose pavyzdžiuose naudojamas tas pats galinis taškas. Atsisiųskite visą pavyzdžių rinkinį: bgcut-api-examples.zip

Oficialus PHP SDK
Atvirojo kodo kliento biblioteka su tipizuotais rezultatais, klaidų klasėmis ir paruoštais naudoti pavyzdžiais. MIT licencija.
composer require bgcut-net/bgcut-php
GitHub

Apribojimai

  • 60 užklausų per minutę vienam API raktui (pageidaujant – didesni limitai).
  • Daugiausia 25 MB ir 30 megapikselių vienam vaizdui; didesni vaizdai sumažinami.
  • Apdoroti vaizdai saugomi 30 d. ir juos galima patobulinti žiniatinklio redaktoriuje.
  • Už nepavykusias užklausas mokestis niekada neimamas; jei nepavyksta sugeneruoti rezultato, mokestis grąžinamas automatiškai.

Pradėkite integraciją

Susikurkite nemokamą paskyrą, sugeneruokite raktą ir atlikite pirmąją užklausą greičiau nei per minutę.

Gauti API raktą Kainos