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. Az egyetlen útvonal, amely kulcs nélkül is válaszol. | — |
| GET | /is-connected | Ellenőrzi, hogy a kulcs érvényes munkaterületre mutat-e. | — |
| 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 | Egy poszt törlése és a hozzá tartozó folyamat leállítása. | posts:draft |
| DELETE | /posts/group/:group | A teljes csoport törlése: egy szerkesztés, ami több csatornára ment ki, egyetlen posztnak számít. | 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 |
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.