Referência da API

Spec OpenAPI gerado das rotas, referência interativa de todas as operações, e como importar o contrato no Postman, no Insomnia ou em um gerador de cliente.

A referência é gerada a cada deploy a partir das próprias rotas: os schemas de corpo, query e parâmetros são os mesmos que a API usa para validar. O que está lá é o que a API aceita.

Referência interativa: api.postmatic.dev/docs, todas as operações com parâmetros, respostas por status e exemplos de requisição em várias linguagens.
Spec OpenAPI 3: api.postmatic.dev/openapi.json.
Índice para agentes: postmatic.dev/llms.txt.

Todas as operações

Operação	Descrição	Auth
`GET /v1/health/auth`	Verifica a credencial e devolve o projeto.	chave ou Bearer
`GET /v1/connect/:platform`	URL de autorização para conectar uma conta.	chave ou Bearer
`GET /v1/connect/integrations`	Lista contas conectadas.	chave ou Bearer
`DELETE /v1/connect/integrations/:id`	Desconecta uma conta.	chave ou Bearer
`GET /v1/integrations/:id/health`	Saúde da conexão de uma conta.	chave ou Bearer
`POST /v1/profiles`	Cria um profile.	chave ou Bearer
`GET /v1/profiles`	Lista profiles.	chave ou Bearer
`DELETE /v1/profiles/:id`	Remove um profile.	chave ou Bearer
`POST /v1/posts`	Cria um post, agora ou agendado.	chave ou Bearer
`GET /v1/posts`	Lista posts.	chave ou Bearer
`GET /v1/posts/:id`	Consulta um post.	chave ou Bearer
`PATCH /v1/posts/:id`	Reagenda um post.	chave ou Bearer
`DELETE /v1/posts/:id`	Cancela um post agendado.	chave ou Bearer
`POST /v1/media`	Envia uma imagem.	chave ou Bearer
`GET /v1/me`	Usuário, organização e projetos.	Bearer
`PATCH /v1/organizations/:id`	Renomeia a organização.	Bearer
`DELETE /v1/me`	Exclui a conta.	Bearer
`GET /v1/projects/:id/api-keys`	Lista chaves de API.	Bearer
`POST /v1/projects/:id/api-keys`	Cria uma chave de API.	Bearer
`DELETE /v1/projects/:id/api-keys/:keyId`	Revoga uma chave.	Bearer
`GET /v1/connect/instagram/callback`	Retorno do OAuth; chamado pela Meta.	pública
`POST /v1/meta/deauthorize`	Callback de desautorização; chamado pela Meta.	pública
`POST /v1/meta/data-deletion`	Callback de exclusão de dados; chamado pela Meta.	pública
`GET /v1/meta/data-deletion/:code`	Status de um pedido de exclusão.	pública
`GET /healthz`	Liveness.	pública

Importar o contrato

Postman e Insomnia: importe pela URL https://api.uat.postmatic.dev/openapi.json. Configure a variável de autenticação como header x-access-key.

Gerar um cliente: qualquer gerador que leia OpenAPI 3 funciona. Com o openapi-generator:

Cliente TypeScript

npx @openapitools/openapi-generator-cli generate \
  -i https://api.uat.postmatic.dev/openapi.json \
  -g typescript-fetch \
  -o ./postmatic-client

Validar requisições em testes: o spec serve como contrato para ferramentas como Prism (@stoplight/prism-cli), que sobem um mock da API a partir dele:

Mock local

npx @stoplight/prism-cli mock https://api.uat.postmatic.dev/openapi.json

O que a referência não cobre

A referência descreve o contrato de cada operação. O comportamento entre operações (o ciclo de vida de um post, quando reconectar uma conta, como repetir com segurança) está nos guias: Publicações, Contas e profiles, Erros.