API-végpontok
Minden API-végpont
A nyilvános REST API teljes végpontlistája metódussal, útvonallal és a hozzá szükséges jogosultsággal.
A teljes lista
Minden útvonal a https://api.posty.hu/public/v1 alatt van. Kattints a névre a részletes leíráshoz, a paraméterekkel és egy futtatható példával.
| Metódus | Útvonal | Mit csinál | Jogosultság |
|---|---|---|---|
| GET | /status | Állapot és felderítés. Kulcs nélkül is válaszol. | |
| POST | /signup/start | Egyszer használatos kódot küld a felhasználó e-mail címére. Kulcs nélkül hívható, és minden címre ugyanazt válaszolja. | |
| POST | /signup/complete | A kóddal és a felhasználó hozzájárulásával (acceptTerms: true) létrehozza a fiókot, és egyszer megmutat egy teljes munkaterületi kulcsot (psty_sa_). Ingyenes próbaidő nincs, a következő lépés a checkout. Ha a címhez már van fiók, 409. | |
| GET | /is-connected | Ellenőrzi, hogy a kulcs érvényes munkaterületre mutat-e. | |
| GET | /workspaces | A kulcs által elérhető munkaterületek. A `current` azt jelöli, amelyikre a kérés érkezett. Ha a kulcs több munkaterületre szól, a többi útvonal a `showorg` fejlécben várja a munkaterület azonosítóját. | |
| GET | /integrations | A bekötött csatornák: azonosító, név, @handle, platform, és hogy tud-e most posztolni. | channels:read |
| GET | /integration-settings/:id | Egy csatorna posztolási szabályai és beállítássémája, a fiókra feloldott karakterkorláttal. | channels:read |
| POST | /integration-trigger/:id | Platformspecifikus lekérdezés egy csatornán: táblák, subredditek, oldalak listája. | channels:read |
| GET | /social/:integration | Visszaadja azt a platformcímet, amit egy embernek meg kell nyitnia a csatorna bekötéséhez. | channels:write |
| GET | /groups | Az ügyfélcsoportok, amelyekbe a csatornák be vannak sorolva. | channels:read |
| GET | /posts | A naptár egy időszakra: minden poszt állapottal és időponttal. | posts:read |
| POST | /posts | Poszt létrehozása: piszkozat, ütemezés vagy azonnali közzététel, egy vagy több csatornára. | posts:draft (közzétételhez posts:publish is) |
| DELETE | /posts/:id | Csak ez az egy poszt (egy csatorna) törlése, a szálával együtt. A csoport többi csatornája marad. | posts:draft |
| DELETE | /posts/group/:group | A teljes csoport törlése, minden csatornáról: egy szerkesztés, ami több csatornára ment ki. | posts:draft |
| PUT | /posts/:id/status | Poszt átmozgatása piszkozat és ütemezett állapot között. | posts:publish |
| GET | /posts/:id/missing | Megmondja, mi hiányzik még a poszthoz a közzétételhez. | posts:read |
| PUT | /posts/:id/release-id | A platformon kívül közzétett poszt azonosítójának és címének rögzítése. | posts:publish |
| GET | /find-slot/:id | A következő szabad időpont a munkaterület ütemezése szerint. | posts:read |
| POST | /upload | Kép vagy videó feltöltése a médiatárba, legfeljebb 1 GB. | media:write |
| POST | /upload-from-url | Médiafájl behúzása nyilvános URL-ről a médiatárba. | media:write |
| POST | /upload-link | Böngészős feltöltési link, ha a fájl a felhasználó eszközén van. | media:write |
| GET | /upload-link/:id | A feltöltési linken beérkezett fájlok, a posztba tehető címmel. | media:write |
| GET | /analytics/:integration | Egy csatorna statisztikái a kért időszakra. | analytics:read |
| GET | /analytics/post/:postId | Egy közzétett poszt platformstatisztikái. | analytics:read |
| GET | /notifications | A munkaterület értesítései, lapozva. | posts:read |
| GET | /fotoai/status | Be van-e kötve a kulcs tulajdonosának FotoAI-fiókja, kiként, és mennyi FotoAI-kredit van rajta. | media:write |
| GET | /fotoai/models | A FotoAI kép- és videómodelljei paraméterekkel (képarány, felbontás, hossz) és kreditárral. | media:write |
| POST | /fotoai/quote | Egy generálás pontos ára és a quote_id (10 percig érvényes). Nem költ semmit. | media:write |
| POST | /fotoai/generations | Generálás indítása a felhasználó FotoAI-kreditjeiből, árplafonnal (max_millicredits vagy quote_id) és idempotencia kulccsal. Az eredmény a médiatárba kerül. | media:write |
| GET | /fotoai/generations | A felhasználó legutóbbi FotoAI-generálásai minden forrásból, jelölve, amelyik már a munkaterület médiatárában van. | media:write |
| GET | /fotoai/generations/:id | Egy generálás állapota; ha kész, a médiatárba mentett képek és videók posztba tehető címmel. | media:write |
| POST | /fotoai/generations/:id/import | Bármelyik FotoAI-generálás (a fotoai.hu-n készültek is) importálása a médiatárba. Kétszer importálva ugyanazt adja vissza. | media:write |
| GET | /plans | A négy csomag (Alap, Pro, Kreátor, Csapat) havi és éves ára forintban, valamint euróban, svájci frankban és dollárban, a fontos korlátok, a próbaidőszak szabálya és a munkaterület jelenlegi csomagja. Csomagkapu nélkül válaszol. | |
| GET | /subscription | A munkaterületet vezérlő előfizetés állapota (none, trialing, active, past_due, read_only, cancelled), a csomag, az időszak vége, és az elmúlt órában elindított, ki nem fizetett checkout. Fizetés után ezt kérdezd le. | |
| POST | /subscriptions/checkout | Stripe Checkout link a választott csomagra és időszakra. Nem terhel semmit: a linket a felhasználó nyitja meg, és a saját Link-tárcájával vagy kártyájával fizet. Csak OAuth-token vagy teljes munkaterületi kulcs (psty_sa_) hívhatja, a fizetőé. | |
| GET | /subscription/portal | Rövid életű link a Stripe számlázási portálra: csomagváltás, lemondás, számlák, kártya. Ugyanaz a hitelesítési szabály, mint a checkoutnál. |
Hogyan olvasd
A „Jogosultság” oszlop azt mutatja, milyen scope kell a kulcsra. Ha hiányzik, a válasz 403, és megnevezi a hiányzót, a kulcstulajdonos aktuális szerepkörével együtt. A scope-ok listáját a Hitelesítés oldalon találod.
Két útvonal, a /status és az /is-connected, nem kér scope-ot. Az elsőhöz hitelesítés sem kell.
A pontos sémák
Ezek az oldalak a használatot írják le, példákkal. A mezőnkénti, géppel olvasható sémát az OpenAPI 3 dokumentum tartalmazza, és abból klienskódot is tudsz generáltatni.
A hibaválaszokról és a hívási korlátokról a Hibák és korlátok oldal ír.
Hiányzik valami erről az oldalról? Írj a [email protected] címre, vagy használd a Segítség oldal űrlapját.