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.

Základy

Základní URL
https://api.posty.hu/public/v1
Verze
V cestě: /public/v1
Autentizace
API klíč jako celá hlavička Authorization, nebo přístupový token OAuth 2.1
Formát
Každý požadavek i každá odpověď je JSON
Datumy
ISO 8601, vždy UTC
Dostupnost
Od tarifu Pro. Viz stránku Tarify.

První volání

/status je jediná cesta, která odpoví i bez klíče. Tím nejrychleji ověříte, že se k nám dostanete, a z odpovědi získáte adresy všech ostatních dokumentů:

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

První autentizované volání vypíše vaše kanály:

curl https://api.posty.hu/public/v1/integrations \
  -H "Authorization: psty_a_kulcsod"
Před API klíčem žádná předpona Bearer

API klíč je celá hodnota hlavičky Authorization, bez Bearer. Předpona Bearer patří k tokenu OAuth. To je nejčastější důvod, proč první volání vrátí 401.

Klíč si vytvoříte sami v Posty. Viz stránku Autentizace.

Co umí v1

API spravuje stejný pracovní prostor jako webové rozhraní. Jediné, co neumí, je propojit kanál, protože to platforma vyžaduje od člověka.

Kompletní seznam najdete na stránce Koncové body. Ke každému koncovému bodu je vlastní stránka.

Tvar požadavku a odpovědi

Každé tělo je JSON a každé datum je ISO 8601 UTC. Chyby jsou také JSON. Jejich tvar a limity volání popisuje stránka Chyby a limity.

Pokud klíč patří k více pracovním prostorům, hlavička showorg vybere, kterého se volání týká.

Strojově čitelný popis

Shrnutí pro agenty
OAuth metadata
https://api.posty.hu/.well-known/oauth-protected-resource
Tato stránka v Markdownu

Z dokumentu OpenAPI si můžete nechat vygenerovat i kód klienta. Názvy všech scope jsou v něm pod components.securitySchemes.

Co dál

Něco vám na této stránce chybí? Napište na [email protected] nebo na stránce Nápověda vyplňte formulář.