Kalo te dokumentacioni
Baza e njohurive

Çelësat API

Një çelës për çdo punë, i kufizuar te lejet dhe dërguesit që i duhen, me çdo thirrje të regjistruar.

Hollësi

  • Krijohen te Cilësimet → Çelësat API, në një hapësirë pune që ju përket. Sekreti shfaqet një herë dhe çdo çelës është oe_live_.
  • Një çelës mban vetëm lejet që zgjidhni, dhe një i ri fillon me emails:send. Mund të mbajë edhe një rol, që është tavan dhe jo leje e dytë: GET /ping kthen lejet që emërton çelësi dhe ato që i la roli, ndaj një 403 për një leje që çelësi e ka qartë ka shkak të dukshëm.
  • Fusha e dërgimit emërton deri në 25 domene të plota dhe 50 adresa të veçanta. Një domen i plotë mbulon edhe adresat e shtuara më vonë, dhe një dërgues jashtë listës refuzohet me 403.
  • Një skadim opsional e lë çelësin të skadojë vetë, deri në dhjetë vjet përpara.
  • Rrotullimi ndërron vetëm sekretin: id-ja, lejet, fusha e dërgimit dhe historia e kërkesave vazhdojnë, dhe sekreti i vjetër ndalon sapo krijohet i riu. Një çelës me keys:write mund ta rrotullojë veten përmes API-së. Revokimi është përditësim dhe jo fshirje, ndaj një thirrje e mëvonshme merr revoked_api_key.
  • Çdo thirrje e autentikuar regjistrohet me metodën, shtegun, gjendjen, kodin e gabimit, kohëzgjatjen, IP-në dhe agjentin e përdoruesit, kurrë me trup apo varg pyetjeje. Faqja e çelësit e tregon si Analitika, Aktiviteti dhe Kërkesat, me rrugët më të përdorura, sa shpesh dështojnë dhe vonesën mesatare, dhe të njëjtat pamje mbulojnë disa çelësa njëherësh. Regjistri mbahet, nuk krasitet.
  • Gjithçka që bën faqja është edhe në API dhe në SDK: GET /keys dhe GET /keys/{id} lexojnë çelësat pa sekretet e tyre, POST /keys krijon një, PATCH /keys/{id} e riemërton, ndryshon scope-t ose fushën e dërgimit dhe e fik e ndez, ndërsa rotate, revoke dhe delete bëjnë atë që thonë. Regjistri i kërkesave dhe aktiviteti lexohen njësoj, për një çelës ose për të gjithë, me filtrat e faqes. Leximi kërkon keys:read dhe çdo ndryshim keys:manage, dy scope që nuk i ka asnjë çelës përveç nëse ia ka dhënë dikush. Edhe serveri MCP lexon regjistrin dhe aktivitetin, si listApiKeyRequests dhe listApiKeyActivity.
  • Një çelës nuk krijon e nuk arrin kurrë një çelës më të gjerë se vetja: scope-t, roli, skadimi, modaliteti dhe fusha e dërgimit duhet të qëndrojnë të gjitha brenda çelësit që bën thirrjen. Verifikimi shtesë nuk mund të zbatohet në një thirrje të bërë me çelës, ndaj keys:manage është një kredencial që krijon kredenciale. Jepjani vetëm një automatizimi që lëshon çelësa, me rolin, fushën e dërgimit dhe skadimin e vet, dhe ndiqni skedën Aktiviteti, ku gjithçka që bën regjistrohet në emër të tij.
  • Çfarë mungon: një çelës nuk mund të lidhet me adresa IP dhe nuk mund të krijohet asnjë çelës në modalitet testi.