REST APIGET

Kim jestem

Odczytaj rolę, obszar roboczy i dokładną listę uprawnień klucza API, którego używasz, aby klient lub agent wiedział, co może zrobić, zanim spróbuje.

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

Zwraca klucz użyty w wywołaniu: jego typ, nazwę, obszar roboczy, rolę, efektywne uprawnienia i datę wygaśnięcia. Może go wywołać każdy ważny klucz, niezależnie od roli.

Klucz API (token Bearer)
Uprawnienie:dowolny ważny kluczRole i uprawnienia

Kiedy wywoływać

Warto wywołać go raz przy starcie integracji i ponownie po błędzie 403, aby sprawdzić, co klucz może w danej chwili. Odpowiedź jest obliczana przy każdym wywołaniu na podstawie roli klucza i aktualnej roli jego twórcy, więc zmienia się, gdy tylko administrator zmieni którąś z nich.

Wskazówka dla agentów: przed zaproponowaniem planowania lub publikacji należy odczytać can. Gdy can.publish ma wartość false, należy tworzyć posty z saveAsDraft: true i poinformować, że musi je opublikować członek obszaru roboczego. Nie należy szukać innego klucza.

Pola odpowiedzi

PoleOpis
tokenTypeapi_token dla klucza ze strony API i agenci AI, oauth dla sesji MCP lub OAuth.
tokenIdID klucza widoczne na stronie API i agenci AI. Null dla sesji OAuth.
tokenNameNazwa nadana kluczowi przy tworzeniu. Null dla sesji OAuth.
workspaceObszar roboczy, w którym działa to wywołanie. Klucz API jest powiązany z jednym obszarem roboczym. Sesja OAuth działa w swoim domyślnym obszarze roboczym, chyba że X-Workspace-Id wskazuje inny.
organizationIdOrganizacja będąca właścicielem obszaru roboczego.
roleRola, z którą działa klucz: key to admin, editor, contributor lub viewer; name to etykieta w języku użytkownika.
issuerRoleAktualna rola członka, który utworzył klucz. Klucz nigdy nie ma większych uprawnień niż ten członek. Null dla sesji OAuth.
permissionsWszystkie uprawnienia klucza w tej chwili, po uwzględnieniu aktualnej roli twórcy. Można je porównać z uprawnieniem podanym na stronie każdego endpointu.
canTrzy wartości logiczne, draft, schedule i publish, dla trzech działań na postach najczęściej wykonywanych przez integracje.
summaryJedno zdanie w języku użytkownika, podające rolę i jej możliwości. Przeznaczone do interfejsu lub transkrypcji agenta.
expiresAtMoment, w którym klucz przestaje działać. Null oznacza, że nigdy nie wygasa.

Odpowiedź jest aktualna

Żadna z tych wartości nie jest zapisana w kluczu. Pole permissions jest przeliczane przy każdym żądaniu na podstawie roli wybranej przy tworzeniu i bieżącej roli twórcy, czyli tak samo, jak robi to każdy inny endpoint przed przyjęciem żądania. To, co /me podaje jako możliwości klucza, dokładnie odpowiada temu, na co pozwoli API.

Opis używanego klucza
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
}