Versionim në URL
Përdor /agent-api/v1 si URL bazë. Fusha të reja jo-prishëse mund t’i shtohen v1; fushat ekzistuese, kuptimet dhe kodet e dokumentuara të gabimeve mbeten të qëndrueshme brenda versionit.
// Politika API
Versionimi dhe zhvlerësimi.
API-ja publike për agjentë përdor versionim në URL që integrimi të fiksojë një kontratë të qëndrueshme dhe ta përmirësojë me vetëdije. Sipërfaqja aktuale e qëndrueshme është v1.
Ndryshime prishëse
Një ndryshim prishës merr një version të ri në URL, dokument të përditësuar OpenAPI dhe shënim migrimi. Versioni i vjetër mbetet i disponueshëm gjatë periudhës së publikuar të mbështetjes.
Sinjalet e zhvlerësimit
Kur një version planifikohet për mbyllje, përgjigjet përfshijnë header-at Deprecation dhe Sunset plus një header Link me rel=deprecation. Faqja e politikës dhe metadatat OpenAPI përditësohen në të njëjtën kohë.
Gjendja aktuale
v1 është versioni aktual i qëndrueshëm dhe nuk ka datë mbylljeje. Nuk ka header Sunset derisa të shpallet një datë reale.
// Header-at e përgjigjes
X-API-Version: v1
RateLimit-Limit: 60;w=60
RateLimit-Remaining: 59
RateLimit-Reset: 42
# only when a retirement date is announced
Deprecation: @<unix-seconds>
Sunset: <HTTP-date>
Link: <https://pjespjes.com/developers/versioning>; rel="deprecation"// Burime të lidhura