API-Endpunkte
Alle API-Endpunkte
Die vollständige Liste der Endpunkte der öffentlichen REST-API, mit Methode, Pfad und der nötigen Berechtigung.
Die vollständige Liste
Jeder Pfad liegt unter https://api.posty.hu/public/v1. Klicke auf den Namen für die ausführliche Beschreibung, mit den Parametern und einem lauffähigen Beispiel.
| Methode | Pfad | Was es tut | Berechtigung |
|---|---|---|---|
| GET | /status | Status und Discovery. Antwortet auch ohne Schlüssel. | |
| POST | /signup/start | Schickt einen Einmalcode an die E-Mail-Adresse des Nutzers. Ohne Schlüssel aufrufbar, und die Antwort ist für jede Adresse gleich. | |
| POST | /signup/complete | Legt mit dem Code und der Zustimmung des Nutzers (acceptTerms: true) das Konto an und zeigt einmalig einen vollständigen Arbeitsbereich-Schlüssel (psty_sa_). Es gibt keine kostenlose Testphase, der nächste Schritt ist der Checkout. 409, wenn es für die Adresse schon ein Konto gibt. | |
| GET | /is-connected | Prüft, ob der Schlüssel auf einen gültigen Arbeitsbereich zeigt. | |
| GET | /workspaces | Die Arbeitsbereiche, die der Schlüssel erreicht. `current` markiert den, auf dem die Anfrage ankam. Gilt der Schlüssel für mehrere Arbeitsbereiche, erwarten die übrigen Routen die Arbeitsbereich-ID im Header `showorg`. | |
| GET | /integrations | Die verbundenen Kanäle: ID, Name, @Handle, Plattform, und ob der Kanal gerade posten kann. | channels:read |
| GET | /integration-settings/:id | Die Posting-Regeln und das Einstellungsschema eines Kanals, mit dem für das Konto aufgelösten Zeichenlimit. | channels:read |
| POST | /integration-trigger/:id | Eine plattformspezifische Abfrage auf einem Kanal: Listen von Boards, Subreddits, Seiten. | channels:read |
| GET | /social/:integration | Gibt die Plattform-URL zurück, die ein Mensch öffnen muss, um den Kanal zu verbinden. | channels:write |
| GET | /groups | Die Kundengruppen, in die die Kanäle einsortiert sind. | channels:read |
| GET | /posts | Der Kalender für einen Zeitraum: jeder Beitrag mit Status und Zeitpunkt. | posts:read |
| POST | /posts | Legt einen Beitrag an: Entwurf, geplant oder sofort veröffentlicht, auf einem oder mehreren Kanälen. | posts:draft (zum Veröffentlichen zusätzlich posts:publish) |
| DELETE | /posts/:id | Löscht nur diesen einen Beitrag (einen Kanal) mit seinem Thread. Die anderen Kanäle der Gruppe bleiben. | posts:draft |
| DELETE | /posts/group/:group | Löscht die ganze Gruppe auf allen Kanälen: eine Bearbeitung, die an mehrere Kanäle ging. | posts:draft |
| PUT | /posts/:id/status | Verschiebt einen Beitrag zwischen Entwurf und geplant. | posts:publish |
| GET | /posts/:id/missing | Sagt, was dem Beitrag für die Veröffentlichung noch fehlt. | posts:read |
| PUT | /posts/:id/release-id | Hält ID und URL eines Beitrags fest, der außerhalb der Plattform veröffentlicht wurde. | posts:publish |
| GET | /find-slot/:id | Der nächste freie Termin nach dem Zeitplan des Arbeitsbereichs. | posts:read |
| POST | /upload | Lädt ein Bild oder Video in die Mediathek hoch, bis 1 GB. | media:write |
| POST | /upload-from-url | Holt eine Mediendatei von einer öffentlichen URL in die Mediathek. | media:write |
| POST | /upload-link | Ein Upload-Link für den Browser, wenn die Datei auf dem Gerät des Nutzers liegt. | media:write |
| GET | /upload-link/:id | Die über einen Upload-Link eingegangenen Dateien, mit einer URL, die in einen Beitrag passt. | media:write |
| GET | /analytics/:integration | Die Statistiken eines Kanals für den angefragten Zeitraum. | analytics:read |
| GET | /analytics/post/:postId | Die Plattformstatistiken eines veröffentlichten Beitrags. | analytics:read |
| GET | /notifications | Die Benachrichtigungen des Arbeitsbereichs, seitenweise. | posts:read |
| GET | /fotoai/status | Ob das FotoAI-Konto des Schlüsselinhabers verbunden ist, als wer, und das FotoAI-Guthaben. | media:write |
| GET | /fotoai/models | Die Bild- und Videomodelle von FotoAI mit ihren Parametern (Seitenverhältnis, Auflösung, Länge) und dem Preis in Credits. | media:write |
| POST | /fotoai/quote | Der genaue Preis einer Generierung und eine quote_id, 10 Minuten gültig. Verbraucht nichts. | media:write |
| POST | /fotoai/generations | Startet eine Generierung mit den FotoAI-Credits des Nutzers, mit Preisobergrenze (max_millicredits oder quote_id) und Idempotenzschlüssel. Das Ergebnis landet in der Mediathek. | media:write |
| GET | /fotoai/generations | Die letzten FotoAI-Generierungen des Nutzers aus allen Quellen, markiert, wenn eine schon in der Mediathek dieses Arbeitsbereichs liegt. | media:write |
| GET | /fotoai/generations/:id | Der Status einer Generierung; wenn fertig, die in der Mediathek gespeicherten Bilder und Videos mit einer URL für den Beitrag. | media:write |
| POST | /fotoai/generations/:id/import | Importiert eine beliebige FotoAI-Generierung (auch auf fotoai.hu erstellte) in die Mediathek. Ein zweiter Import liefert dieselben Medien. | media:write |
| GET | /plans | Die vier Tarife (Alap, Pro, Kreátor, Csapat) mit Monats- und Jahrespreis in Forint, Euro, Schweizer Franken und US-Dollar, die wichtigsten Limits, die Regel der Testphase und der aktuelle Tarif des Arbeitsbereichs. Antwortet ohne Tarifsperre. | |
| GET | /subscription | Der Status des Abonnements, das den Arbeitsbereich steuert (none, trialing, active, past_due, read_only, cancelled), der Tarif, das Ende des Zeitraums und ein in der letzten Stunde gestarteter, unbezahlter Checkout. Frag das nach der Zahlung ab. | |
| POST | /subscriptions/checkout | Ein Stripe-Checkout-Link für den gewählten Tarif und Zeitraum. Er belastet nichts: Der Nutzer öffnet den Link und zahlt mit seiner eigenen Link-Wallet oder Karte. Nur ein OAuth-Token oder ein vollständiger Arbeitsbereich-Schlüssel (psty_sa_) des Zahlenden kann ihn aufrufen. | |
| GET | /subscription/portal | Ein kurzlebiger Link zum Stripe-Abrechnungsportal: Tarifwechsel, Kündigung, Rechnungen, Karte. Dieselbe Authentifizierungsregel wie beim Checkout. |
So liest du sie
Die Spalte „Berechtigung“ zeigt, welchen Scope der Schlüssel braucht. Fehlt er, ist die Antwort 403. Sie nennt den fehlenden Scope und die aktuelle Rolle des Schlüsselinhabers. Die Liste der Scopes findest du auf der Seite Authentifizierung.
Zwei Pfade, /status und /is-connected, brauchen keinen Scope. Der erste braucht auch keine Authentifizierung.
Die genauen Schemas
Diese Seiten beschreiben die Nutzung mit Beispielen. Das maschinenlesbare Schema, Feld für Feld, steht im OpenAPI-3-Dokument, und daraus kannst du auch Clientcode generieren lassen.
Fehlerantworten und Aufruflimits stehen auf der Seite Fehler und Limits.
Fehlt etwas auf dieser Seite? Schreib eine E-Mail an [email protected] oder nutze auf der Hilfeseite das Formular.