Список API-ключей

GET /v1/api-keys

Список всех активных (не отозванных) API-ключей для аутентифицированного пользователя. Ответ никогда не содержит значения ключей в открытом виде или их хешей -- только метаданные для идентификации и управления.

Попробуйте

Протестируйте этот эндпоинт интерактивно в Swagger UI.

Требуется авторизация

Укажите ваш API-ключ в заголовке Authorization.

Запрос

Заголовки

Заголовок	Значение	Обязательно
Authorization	Bearer <token>	Да

Этот эндпоинт не принимает параметров запроса или тела запроса.

Примеры кода

curl

curl https://api.docmap.io/v1/api-keys \
  -H "Authorization: Bearer dm_live_abc123def456ghi789jkl012mno345"

TypeScript

const apiKey = process.env.DOCMAP_API_KEY

const response = await fetch('https://api.docmap.io/v1/api-keys', {
  headers: { 'Authorization': `Bearer ${apiKey}` },
})

const { data } = await response.json()

for (const key of data) {
  console.log(`${key.name} (${key.prefix}...) — created ${key.createdAt}`)
}

Python

import requests

api_key = "dm_live_abc123def456ghi789jkl012mno345"

response = requests.get(
    "https://api.docmap.io/v1/api-keys",
    headers={"Authorization": f"Bearer {api_key}"},
)

keys = response.json()["data"]

for key in keys:
    print(f"{key['name']} ({key['prefix']}...) — created {key['createdAt']}")

Ответ

Статус: 200 OK

Тело ответа содержит массив data с объектами метаданных API-ключей.

Поля

Каждый объект в массиве содержит:

Поле	Тип	Описание
id	string	Уникальный идентификатор API-ключа.
userId	string	ID пользователя, которому принадлежит ключ.
name	string	Описательная метка ключа.
prefix	string	Первые символы ключа для идентификации (например, dm_live_abc1).
expiresAt	string | null	Временная метка ISO 8601 истечения срока действия, или null, если ключ бессрочный.
lastUsedAt	string | null	Временная метка ISO 8601 последнего использования ключа. null, если никогда не использовался.
createdAt	string	Временная метка ISO 8601 создания ключа.
revoked	boolean	Был ли ключ отозван. В этом ответе всегда false, так как возвращаются только активные ключи.

Пример

{
  "data": [
    {
      "id": "ak_1a2b3c4d5e6f7g8h",
      "userId": "uid_a1b2c3d4e5f6",
      "name": "Production Server",
      "prefix": "dm_live_r4nd",
      "expiresAt": "2025-02-18T10:00:00.000Z",
      "lastUsedAt": "2024-11-20T16:45:00.000Z",
      "createdAt": "2024-11-20T10:00:00.000Z",
      "revoked": false
    },
    {
      "id": "ak_9i8h7g6f5e4d3c2b",
      "userId": "uid_a1b2c3d4e5f6",
      "name": "Local Development",
      "prefix": "dm_live_t3st",
      "expiresAt": null,
      "lastUsedAt": "2024-11-19T08:30:00.000Z",
      "createdAt": "2024-10-05T12:00:00.000Z",
      "revoked": false
    }
  ]
}

Ошибки

Статус	Код	Описание
401	UNAUTHORIZED	Отсутствующий, недействительный или просроченный API-ключ / токен.