Nyilvános API

Hitelesítés és jogosultságok

API-kulcs, MCP-kulcs, OAuth-token: melyik mire való, hogyan készíted el, és mit jelentenek a scope-ok.

Három hitelesítő adat

TípusElőtagHol használodHonnan van
API-kulcspsty_…REST API és a parancssori eszközBeállítások → Fejlesztőknek
MCP-kulcspsty_mcp_…MCP-szerver, chatkliensekhezBeállítások → Fejlesztőknek
OAuth-tokenpos_…Ha egy alkalmazás mások nevében fér hozzáAz OAuth folyamat végén
A REST-kulcs és az MCP-kulcs nem cserélhető fel

Az MCP-szerveren szándékosan visszautasítjuk a psty_ kezdetű REST-kulcsot, és azt is megírjuk, miért. Ha egy chatkliens nem tud csatlakozni, ez a leggyakoribb ok.

Az API-kulcs

A kulcsot a Postyban készíted, a Beállítások → Fejlesztőknek oldalon. Nem kell hozzá írnod nekünk, és nincs jóváhagyási kör. A kulcs a létrehozás pillanatában látszik egyszer, utána már nem kérdezhető vissza.

Minden kérés a kulcsot az Authorization fejlécben viszi. A kulcs a fejléc teljes értéke:

curl https://api.posty.hu/public/v1/integrations \
  -H "Authorization: psty_a_kulcsod"

OAuth-tokennél viszont van Bearer előtag:

curl https://api.posty.hu/public/v1/integrations \
  -H "Authorization: Bearer pos_a_tokened"

Jogosultságok

A kulcs szűkíthető: csak azokat a műveleteket engeded meg neki, amikre tényleg szükség van. Ezek a scope-ok, és a https://api.posty.hu/public/v1/status válasza is felsorolja őket.

ScopeMit enged
posts:readA naptár és a bejegyzések olvasása.
posts:draftPiszkozat létrehozása, szerkesztése, törlése.
posts:publishÜtemezés és azonnali közzététel, valamint a piszkozatból kimozdítás.
channels:readCsatornák, csoportok és beállítássémák olvasása.
channels:writeCsatorna bekötésének elindítása.
media:writeFeltöltés a médiatárba.
analytics:readStatisztikák olvasása.

MCP-n két scope van: mcp:read és mcp:write.

Adj a lehető legkevesebbet

Egy piszkozatokat készítő ügynöknek elég a posts:read és a posts:draft. Így ha bármi félremegy, a legrosszabb, ami történhet, egy fölösleges piszkozat, nem egy valódi közönségnek kiment bejegyzés.

Munkaterület választása

Ha egy kulcs több munkaterülethez tartozik, a showorg fejléc választja ki, melyikre vonatkozik a hívás:

curl https://api.posty.hu/public/v1/integrations \
  -H "Authorization: psty_a_kulcsod" \
  -H "showorg: <munkaterulet-azonosito>"

401 és 403

KódMit jelentMit tegyél
401A hitelesítő adat hiányzik, hibás, lejárt vagy visszavonásra került.Ellenőrizd, hogy a kulcs a teljes Authorization fejléc értéke-e, Bearer nélkül, és hogy nem cserélted-e le közben.
403A hitelesítés rendben, de a jogosultság nem elég.A válasz megnevezi a hiányzó scope-ot és a kulcs tulajdonosának aktuális szerepkörét. Nézd meg mindkettőt.
A 403 leggyakrabban a felhasználóról szól

A kulcs jogosultsága a tulajdonosa aktuális szerepkörével mozog. Ha valakit lefokoztak vagy kivettek a munkaterületről, a kulcsa azonnal annyit tud, amennyit ő. Egy tegnap még működő kulcs mai 403-a szinte mindig ez.

Kulcskezelés

  • Környezeti változóba vagy titokkezelőbe tedd, ne a kódba, és ne verziókövetőbe.
  • Ha kikerült valahova, cseréld le a Beállítások → Fejlesztőknek oldalon. A csere azonnali, a régi kulcs a következő híváskor 401-et kap.
  • A parancssori eszközhöz nem is kell kulcsot másolnod: a posty auth:login a gépeden tárolja a hitelesítő adatot. Lásd a CLI-hitelesítés oldalt.
  • Az API-kulcsot soha ne küldd el nekünk levélben. Nincs rá szükségünk.
Hiányzik valami erről az oldalról? Írj a [email protected] címre, vagy használd a Segítség oldal űrlapját.