Mwanzo wa haraka
Ingia, unda mradi wa majaribio, unda ufunguo wenye ruhusa zinazohitajika tu, ita GET /v1/tools, sanidi huduma moja, kisha unda ufunguo tofauti wa live baada ya majaribio ya kukubalika.
export GALON_API_BASE="https://api.galon.ai"
export GALON_API_KEY="gln_test_..."
curl "$GALON_API_BASE/v1/tools" -H "Authorization: Bearer $GALON_API_KEY"
Uthibitishaji na utengaji
Tuma ufunguo wa API katika kichwa Authorization: Bearer. Kila ufunguo umefungwa kwa tenant, mradi na mazingira moja. Uuhifadhi tu katika hifadhi ya siri ya seva; kamwe katika kivinjari, programu ya simu au hazina ya msimbo.
Funguo zilizowekewa mipaka ya huduma
Toa ruhusa mahususi kama mail:send, domain:lookup au build:create. Tumia ufunguo mmoja kwa kila programu. Epuka ruhusa pana za huduma isipokuwa muunganisho unahitaji shughuli zote, na batilisha mara moja funguo zisizotumika.
mail:send
domain:lookup
domain:read
build:create
build:read
artifact:read
job:read
Kazi zisawazishwa na idempotency
Mabadiliko hurudisha job. Tuma Idempotency-Key thabiti: ufunguo na nia ileile hurudisha job ileile; ufunguo uleule wenye nia tofauti hurudisha HTTP 409. Fuatilia job na urudie tu maombi salama au idempotent.
POST /v1/jobs
GET /v1/jobs/{job_id}
POST /v1/jobs/{job_id}/cancel
GET /v1/builds/{job_id}/artifacts
Kutuma barua pepe
POST /v1/emails hupokea from_email, subject, text au html, na to: anwani moja au orodha. cc na bcc ni orodha za hiari; to, cc na bcc kwa pamoja hubeba wapokeaji tofauti wasiozidi 50, na kila mpokeaji huhesabiwa katika kiwango chako na matumizi yanayotozwa. Kila mpokeaji hupokea nakala yake mwenyewe yenye kiungo chake cha kujiondoa kwa mbofyo mmoja, hivyo wapokeaji wa bcc hawafichuliwi kamwe; wapokeaji waliozuiwa (barua zilizorudi, malalamiko, waliojiondoa) hurukwa. attachments ni orodha ya vitu visivyozidi 10 vyenye filename, content (base64) na content_type ya hiari; ujumbe uliosimbwa lazima ubaki chini ya MB 25 na faili zinazotekelezeka hukataliwa. scheduled_at (ISO 8601 yenye saa za eneo, isiyozidi saa 72 mbele) huahirisha utumaji; POST /v1/emails/{job_id}/cancel huughairi ukiwa bado kwenye foleni. POST /v1/emails/batch hupokea {"emails": [...]} yenye ujumbe 1 hadi 100 bila viambatisho; kila ujumbe huwa job yake, idempotent kwa Idempotency-Key ya kundi na nafasi yake. to_email bado inakubaliwa kwa mpokeaji mmoja. Usajili wa kundi pekee ndio wa atomiki (atomic=true); utekelezaji na uwasilishaji ni huru. Jaribio la kurudia linahitaji orodha ileile iliyopangwa; badiliko lolote la maudhui, ukubwa au mpangilio hurudisha HTTP 409.
POST /v1/emails
POST /v1/emails/batch
POST /v1/emails/{job_id}/cancel
Hitilafu
Chukulia HTTP 401 kama kitambulisho batili au kilichoisha, 403 kama ruhusa haitoshi, 409 kama mgongano wa idempotency au toleo, 422 kama ombi batili na 503 kama huduma kutopatikana kwa muda.
Rejea inayosomeka na mashine
Tumia mkataba wa OpenAPI kwa miundo na mwongozo wa ujumuishaji wa LLM kwa maelekezo ya mawakala. Kiingereza ndicho chanzo rasmi; njia, sehemu, ruhusa na mifano ni sawa katika kila tafsiri.