REST APIGET

Quem sou eu

Leia o papel, o espaço de trabalho e a lista exata de permissões da chave de API com que você chama, para que um cliente ou agente saiba o que pode fazer antes de tentar.

GEThttps://post.adaptlypost.com/post/api/v1/me

Devolve a chave com que você está chamando: tipo, nome, espaço de trabalho, papel, permissões efetivas e validade. Qualquer chave válida pode chamá-lo, seja qual for o papel.

Chave API (Bearer token)
Permissão:qualquer chave válidaPapéis e permissões

Quando chamar

Chame-o uma vez quando uma integração inicia, e de novo depois de um 403, para saber o que a chave pode fazer agora. A resposta é calculada a cada chamada a partir do papel da chave e do papel atual do criador, então muda no momento em que um administrador altera qualquer um dos dois.

Se você é um agente: leia can antes de oferecer agendar ou publicar. Quando can.publish for false, crie as publicações com saveAsDraft: true e diga que um membro do espaço de trabalho precisa publicá-las. Não procure outra chave.

Campos da resposta

CampoDescrição
tokenTypeapi_token para uma chave da página Tokens de API, oauth para uma sessão MCP ou OAuth.
tokenIdO ID da chave como aparece na página Tokens de API. Null numa sessão OAuth.
tokenNameO nome dado à chave quando foi criada. Null numa sessão OAuth.
workspaceO espaço de trabalho em que a chave age. Uma chave está ligada a um único espaço de trabalho.
organizationIdA organização dona do espaço de trabalho.
roleO papel com que a chave age: key é admin, editor, contributor ou viewer; name é o rótulo no seu idioma.
issuerRoleO papel atual do membro que criou a chave. A chave nunca tem mais do que esse membro. Null numa sessão OAuth.
permissionsCada permissão que a chave tem agora, depois de aplicado o papel atual do criador. Compare com a permissão indicada em cada página de endpoint.
canTrês booleanos, draft, schedule e publish, para as três coisas que a maioria das integrações faz com publicações.
summaryUma frase, no seu idioma, que nomeia o papel e o que ele pode fazer. Pensada para uma interface ou a transcrição de um agente.
expiresAtQuando a chave para de funcionar. Null significa que nunca expira.

A resposta é ao vivo

Nada disso fica gravado na chave. permissions é recalculado a cada requisição a partir do papel escolhido na criação e do papel do criador naquele momento, o mesmo cálculo que todo outro endpoint executa antes de aceitar uma requisição. O que /me diz que uma chave pode fazer é exatamente o que a API vai permitir.

Descrever a chave que chama
curl --request GET \
  --url https://post.adaptlypost.com/post/api/v1/me \
  --header 'Authorization: Bearer <api-key>'
200
{
  "tokenType": "api_token",
  "tokenId": "tok_01j9x4k2",
  "tokenName": "Zapier drafts",
  "workspace": { "id": "ag_01j9x" },
  "organizationId": "org_01hzq",
  "role": { "key": "contributor", "name": "Contributor" },
  "issuerRole": "editor",
  "permissions": [
    "workspace.read",
    "posts.read",
    "accounts.read",
    "posts.draft",
    "media.upload",
    "analytics.read",
    "ai.generate",
    "members.read",
    "tokens.own"
  ],
  "can": { "draft": true, "schedule": false, "publish": false },
  "summary": "This key acts as Contributor in this workspace and can create drafts, but cannot schedule or publish them.",
  "expiresAt": null
}