Nyilvános API

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.

Grundlagen

Basis-URL
https://api.posty.hu/public/v1
Version
Im Pfad: /public/v1
Authentifizierung
API-Schlüssel als kompletter Authorization-Header, oder ein OAuth-2.1-Zugriffstoken
Format
Jede Anfrage und jede Antwort ist JSON
Datum
ISO 8601, immer UTC
Verfügbarkeit
Ab dem Pro-Tarif. Siehe die Tarife-Seite.

Der erste Aufruf

/status ist der einzige Pfad, der auch ohne Schlüssel antwortet. Damit prüfst du am schnellsten, ob du uns erreichst, und bekommst die Adressen aller anderen Dokumente:

curl https://api.posty.hu/public/v1/status

Der erste authentifizierte Aufruf listet deine Kanäle:

curl https://api.posty.hu/public/v1/integrations \
  -H "Authorization: psty_a_kulcsod"
Kein Bearer-Präfix vor dem API-Schlüssel

Der API-Schlüssel ist der komplette Wert des Authorization-Headers, ohne Bearer. Das Bearer-Präfix gehört zum OAuth-Token. Das ist der häufigste Grund, warum ein erster Aufruf eine 401 bekommt.

Den Schlüssel erstellst du selbst in Posty. Siehe die Seite Authentifizierung.

Was v1 kann

Die API verwaltet denselben Arbeitsbereich wie die Weboberfläche. Nur eines kann sie nicht: einen Kanal verbinden, weil die Plattform das von einem Menschen verlangt.

Die vollständige Liste findest du auf der Seite Endpunkte, mit einer eigenen Seite für jeden Endpunkt.

Form von Anfrage und Antwort

Jeder Body ist JSON, und jedes Datum ist ISO 8601 UTC. Fehler sind ebenfalls JSON. Ihre Form und die Aufruflimits beschreibt die Seite Fehler und Limits.

Wenn ein Schlüssel zu mehreren Arbeitsbereichen gehört, wählt der showorg-Header, auf welchen sich der Aufruf bezieht.

Maschinenlesbare Beschreibung

Zusammenfassung für Agenten
OAuth-Metadaten
https://api.posty.hu/.well-known/oauth-protected-resource
Diese Seite als Markdown

Aus dem OpenAPI-Dokument kannst du auch Clientcode generieren. Die Namen aller Scopes stehen darin unter components.securitySchemes.

Weiter

Fehlt etwas auf dieser Seite? Schreib eine E-Mail an [email protected] oder nutze auf der Hilfeseite das Formular.