Farawa cikin sauri
Shiga, ƙirƙiri aikin gwaji, ƙirƙiri maɓalli da izinin da ake buƙata kawai, kira GET /v1/tools, saita sabis ɗaya, sannan ƙirƙiri maɓallin live daban bayan gwajin karɓa.
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"
Tabbatarwa da warewa
Aika maɓallin API a cikin taken Authorization: Bearer. Kowane maɓalli yana daure da tenant, aiki da muhalli guda ɗaya. Ajiye shi kawai a ma'ajiyar sirrin saba; kada a saka shi a burauza, manhajar waya ko ma'ajiyar lamba.
Maɓallan da aka iyakance ga sabis
Ba da takamaiman izini kamar mail:send, domain:lookup ko build:create. Yi amfani da maɓalli ɗaya ga kowace manhaja. Guji izinin sabis gaba ɗaya sai idan haɗin yana buƙatar duk ayyuka, kuma soke maɓallan da ba a amfani da su nan take.
mail:send
domain:lookup
domain:read
build:create
build:read
artifact:read
job:read
Ayyukan baya da idempotency
Canje-canje suna dawo da job. Aika Idempotency-Key tabbatacce: maɓalli da niyya iri ɗaya suna dawo da job ɗaya; maɓalli ɗaya da wata niyya yana dawo da HTTP 409. Duba job kuma sake gwada buƙatun da suke lafiya ko idempotent kawai.
POST /v1/jobs
GET /v1/jobs/{job_id}
POST /v1/jobs/{job_id}/cancel
GET /v1/builds/{job_id}/artifacts
Aika imel
POST /v1/emails yana karɓar from_email, subject, text ko html, da to: adireshi ɗaya ko jerin adireshi. cc da bcc jerin zaɓi ne; to, cc da bcc tare ba su wuce masu karɓa daban-daban 50 ba, kuma kowane mai karɓa yana ƙidaya a cikin iyakarka da amfanin da ake caji. Kowane mai karɓa yana samun kwafinsa na kansa tare da mahaɗin cire rajista na dannawa ɗaya, don haka ba a taɓa bayyana masu karɓar bcc ba; ana tsallake masu karɓa da aka toshe (saƙonnin da suka dawo, ƙorafe-ƙorafe, cire rajista). attachments jerin abubuwa ne da ba su wuce 10 ba masu filename, content (base64) da content_type na zaɓi; saƙon da aka ɓoye dole ya kasance ƙasa da MB 25, kuma ana ƙin fayilolin da ake iya gudanarwa. scheduled_at (ISO 8601 tare da yankin lokaci, wanda bai wuce awa 72 a gaba ba) yana jinkirta aikawa; POST /v1/emails/{job_id}/cancel yana soke shi muddin yana cikin layi. POST /v1/emails/batch yana karɓar {"emails": [...]} da saƙonni 1 zuwa 100 ba tare da haɗe-haɗe ba; kowane saƙo ya zama job nasa, idempotent ta Idempotency-Key na rukunin da matsayinsa. Har yanzu ana karɓar to_email don mai karɓa ɗaya. Rajistar rukunin kaɗai ne atomic (atomic=true); aiwatarwa da isarwa suna zaman kansu. Sake gwadawa yana buƙatar jerin da aka jera iri ɗaya; duk canjin abun ciki, girma ko tsari yana dawo da HTTP 409.
POST /v1/emails
POST /v1/emails/batch
POST /v1/emails/{job_id}/cancel
Kurakurai
HTTP 401 na nufin bayanan shiga marasa inganci ko waɗanda suka ƙare, 403 izini bai isa ba, 409 rikicin idempotency ko sigar, 422 buƙata mara inganci, 503 kuma rashin samuwa na ɗan lokaci.
Manazarta mai karantawa ta na'ura
Yi amfani da kwangilar OpenAPI don tsari da jagorar haɗa LLM don umarnin wakilai. Turanci ne tushe na hukuma; hanyoyi, filaye, izini da misalai iri ɗaya ne a kowane fassara.