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.

The basics

Base URL
https://api.posty.hu/public/v1
Version
In the path: /public/v1
Authentication
API key as the entire Authorization header, or an OAuth 2.1 access token
Format
Every request and response is JSON
Dates
ISO 8601, always UTC
Availability
Available on the Pro plan and above. See the Plans page.

The first call

/status is the only path that responds without a key. That's the fastest way to check you can reach us, and it gives you the URL of every other document:

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

The first authenticated call lists your channels:

curl https://api.posty.hu/public/v1/integrations \
  -H "Authorization: psty_a_kulcsod"
No Bearer prefix in front of the API key

The API key is the Authorization header's entire value, with no Bearer. The Bearer prefix belongs to the OAuth token. That's the most common reason a first call gets a 401.

You create the key yourself in Posty. See the Authentication page.

What v1 can do

The API manages the same workspace as the web interface. The one thing it cannot do is connect a channel, because the platform asks a person to do that.

You'll find the full list on the Endpoints page, with a separate page for each endpoint.

Request and response shape

Every body is JSON, and every date is ISO 8601 UTC. Errors are JSON too. The Errors and limits page describes their shape and the rate limits.

If a key belongs to more than one workspace, the showorg header selects which one the call applies to.

Machine-readable description

Summary for agents
OAuth metadata
https://api.posty.hu/.well-known/oauth-protected-resource

You can generate client code from the OpenAPI document, and every scope name is in it under components.securitySchemes.

What's next

Is something missing from this page? Email [email protected] or use the form on the Help page.