A nyilvános REST API
Alapcím, első hívás, a kérés és a válasz alakja, és hol van a gépi leírás.
Alapadatok
https://api.posty.hu/public/v1Authorization fejlécként, vagy OAuth 2.1 hozzáférési tokenAz első hívás
A /status az egyetlen útvonal, amely kulcs nélkül is válaszol. Ezzel tudod a leggyorsabban eldönteni, hogy elérsz-e minket, és megkapod belőle minden más dokumentum címét:
curl https://api.posty.hu/public/v1/statusAz első hitelesített hívás pedig a csatornáidat listázza:
curl https://api.posty.hu/public/v1/integrations \
-H "Authorization: psty_a_kulcsod"Az API-kulcs a Authorization fejléc teljes értéke, Bearer nélkül. A Bearer előtag az OAuth-tokenhez tartozik. Ez a leggyakoribb ok, amiért egy első hívás 401-et kap.
A kulcsot magad készíted a Postyban; lásd a Hitelesítés oldalt.
Mit tud a v1
Az API ugyanazt a munkaterületet kezeli, mint a webes felület. Egyetlen dolgot nem tud: csatornát bekötni, mert azt a platform egy embertől kéri.
A teljes listát a Végpontok oldalon találod, minden végponthoz külön oldallal.
A kérés és a válasz alakja
Minden törzs JSON, és minden dátum ISO 8601 UTC. A hibák is JSON-ok; az alakjukat és a hívási korlátokat a Hibák és korlátok oldal írja le.
Ha egy kulcs több munkaterülethez tartozik, a showorg fejléc választja ki, melyikre vonatkozik a hívás.
Gépi leírás
https://api.posty.hu/.well-known/oauth-protected-resourceAz OpenAPI dokumentumból klienskódot is tudsz generáltatni, és minden scope neve benne van a components.securitySchemes alatt.