bgCut.net API

លុបផ្ទៃខាងក្រោយពីកម្មវិធី ហាង ឬ pipeline ផ្ទាល់ខ្លួនរបស់អ្នក ដោយប្រើសំណើ HTTPS តែមួយ។

URL មូលដ្ឋាន៖ https://bgcut.net/api/v1 · ទទួលបានសោរបស់អ្នកនៅក្រោម សោ API.

ការផ្ទៀងផ្ទាត់

រាល់សំណើត្រូវតែភ្ជាប់ API key របស់អ្នកនៅក្នុង header X-Api-Key។ Key ត្រូវបានបង្កើត និងដកហូតនៅក្នុងគណនីរបស់អ្នក។ Key នីមួយៗអាចដាក់ឈ្មោះបាន ដើម្បីឱ្យអ្នកអាចប្ដូរវាតាមកម្មវិធីនីមួយៗ។

X-Api-Key: bgc_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

ឬផ្ញើវាជា Bearer token៖ Authorization: Bearer bgc_…

POST /remove

ផ្ញើរូបភាពជាឯកសារ multipart ជា URL ឬជាទម្រង់ base64។ តាមលំនាំដើម ការឆ្លើយតបគឺជារូបភាពលទ្ធផល (binary)។

ប៉ារ៉ាម៉ែត្រ

ប៉ារ៉ាម៉ែត្រប្រភេទការពិពណ៌នា
image_filefileឯកសាររូបភាព (multipart/form-data)។ JPG, PNG, WebP, GIF, BMP, TIFF; អតិបរមា 25 MB / 30 MP។
image_urlstringURL សាធារណៈនៃរូបភាពដែលត្រូវទាញយក ជំនួសឱ្យការផ្ទុកឡើង។
image_file_b64stringរូបភាពក្នុងទម្រង់ base64 (អាចមានបុព្វបទ data: ក៏បាន)។
sizeauto | preview | fullpreview = រហូតដល់ 640 px (ប្រើកូតាឥតគិតថ្លៃប្រចាំខែរបស់អ្នក មិនប្រើក្រេឌីត); full = គុណភាពបង្ហាញដើម (1 ក្រេឌីត); auto (លំនាំដើម) = full នៅពេលអ្នកមានក្រេឌីត បើមិនដូច្នោះទេ preview។
formatpng | jpg | webpទម្រង់លទ្ធផល។ png រក្សាភាពថ្លា; jpg ត្រូវបានបញ្ចូលជាស្រទាប់តែមួយលើ bg_color (លំនាំដើមពណ៌ស)។
modelfast | hq | portraitlite (លំនាំដើម ~6 វិនាទី តុល្យភាពល្អបំផុត), fast (~0.5 វិនាទី គុណភាពកម្រិត preview), hq (~15 វិនាទី គុណភាពខ្ពស់បំផុត), portrait (~0.3 វិនាទី សម្រាប់តែមនុស្សប៉ុណ្ណោះ)។
bg_colorstringកូដពណ៌ Hex សម្រាប់ផ្ទៃខាងក្រោយ ឧ. #ffffff។ ទុកឱ្យនៅទទេសម្រាប់ផ្ទៃថ្លា។
bg_blurnumberរក្សាផ្ទៃខាងក្រោយដើម ប៉ុន្តែធ្វើឱ្យព្រាលតាមកាំនេះជាភីកសែល (1–200) ឧ. 25 សម្រាប់រូបរាងបែប portrait mode។ ជំនួស bg_color។
cropbooleanកាត់លទ្ធផលតាមប្រអប់ព័ទ្ធជុំវិញវត្ថុ។
crop_marginintegerគម្លាតបន្ថែមជាភីកសែលជុំវិញវត្ថុ ពេលកាត់ (0–200)។
roistringតំបន់ដែលចាប់អារម្មណ៍ ជាប្រភាគ x,y,w,h (0–1)។ AI មើលតែក្នុងចតុកោណនេះប៉ុណ្ណោះ; អ្វីៗនៅខាងក្រៅនឹងក្លាយជាថ្លា។
feathernumberធ្វើឱ្យគែមទន់តាមកាំនេះជាភីកសែល (0–5)។
qualityintegerគុណភាព JPG/WebP 50–100 (លំនាំដើម 92)។
responsebinary | jsonbinary (លំនាំដើម) ផ្ដល់រូបភាពមកវិញ; json ផ្ដល់ទិន្នន័យមេតា រួមជាមួយរូបភាព base64។

ការឆ្លើយតប

សំណើដែលជោគជ័យនឹងផ្ដល់ HTTP 200 ជាមួយបៃរូបភាព និង header ទាំងនេះ៖

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

ជាមួយ response=json អ្នកនឹងទទួលបាន៖

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

ផ្ដល់រូបភាព 100 ចុងក្រោយដែលបានដំណើរការដោយ API key របស់អ្នក រួមទាំង URL កម្មវិធីកែសម្រួល ដើម្បីកែលម្អវានៅក្នុងកម្មវិធីរុករក។

កំហុស

កំហុសត្រូវបានផ្ដល់ជា JSON ដែលមានកូដកំហុស និងសារដែលមនុស្សអាចអានយល់៖

{ "ok": false, "error": "insufficient_credits", "message": "No credits left. Buy credits at https://bgcut.net/pricing or request size=preview." }
HTTPerrorការពិពណ៌នា
400bad_request / missing_imageប៉ារ៉ាម៉ែត្របាត់ ឬមិនត្រឹមត្រូវ។
401auth_required / invalid_keyAPI key បាត់ មិនត្រឹមត្រូវ ឬត្រូវបានដកហូត។
402insufficient_credits / free_quota_exceededគ្មានក្រេឌីត (សម្រាប់ទំហំ full) ឬកូតាឥតគិតថ្លៃបានអស់ (សម្រាប់ preview)។
422too_large / bad_type / fetch_failedមិនអាចអាន ឬទាញយករូបភាពបានទេ។
429rate_limitedសំណើច្រើនពេក – សូមបន្ថយល្បឿន ឬទាក់ទងមកយើងសម្រាប់ដែនកំណត់ខ្ពស់ជាងនេះ។
500processing_failedការដំណើរការបរាជ័យពីខាងយើង – អ្នកមិនត្រូវបានគិតថ្លៃទេ។

កូដគំរូ

គំរូទាំងអស់ប្រើ endpoint ដូចគ្នា។ ទាញយកបណ្ដុំឧទាហរណ៍ពេញលេញ៖ bgcut-api-examples.zip

PHP SDK ផ្លូវការ
បណ្ណាល័យ client ប្រភពបើកចំហ ជាមួយលទ្ធផលដែលមានប្រភេទច្បាស់លាស់ ថ្នាក់កំហុស និងឧទាហរណ៍ដែលអាចដំណើរការភ្លាមៗ។ អាជ្ញាប័ណ្ណ MIT។
composer require bgcut-net/bgcut-php
GitHub

ដែនកំណត់

  • 60 សំណើក្នុងមួយនាទី សម្រាប់ API key នីមួយៗ (ដែនកំណត់ខ្ពស់ជាងនេះតាមការស្នើសុំ)។
  • អតិបរមា 25 MB និង 30 មេហ្គាភីកសែលក្នុងមួយរូបភាព; រូបភាពធំជាងនេះនឹងត្រូវបានបង្រួមទំហំ។
  • រូបភាពដែលបានដំណើរការត្រូវបានរក្សាទុករយៈពេល 30 ថ្ងៃ ហើយអាចកែលម្អបាននៅក្នុងកម្មវិធីកែសម្រួលលើវេប។
  • សំណើដែលបរាជ័យមិនត្រូវបានគិតថ្លៃឡើយ; ការគិតថ្លៃនឹងត្រូវបានបង្វិលសងដោយស្វ័យប្រវត្តិ ប្រសិនបើការបង្កើតលទ្ធផលបរាជ័យ។

ចាប់ផ្ដើមភ្ជាប់ប្រព័ន្ធ

បង្កើតគណនីឥតគិតថ្លៃ បង្កើត key ហើយធ្វើការហៅលើកដំបូងរបស់អ្នកក្នុងរយៈពេលតិចជាងមួយនាទី។

ទទួលបាន API key តម្លៃ