API Keys

Для заголовків автентифікації, ключів API та загального формату помилок перегляньте API General.

Автентифікація за допомогою ключа API

Ендпоїнти, захищені за допомогою ключа API, приймають ключ двома способами:

# Через заголовок
curl https://api.fonproxy.io/some-endpoint \
  -H "x-api-key: fnp_a1b2c3d4e5f6..."
 
# Через параметр запиту
curl "https://api.fonproxy.io/some-endpoint?apikey=fnp_a1b2c3d4e5f6..."

Ключ API автентифікується як користувач, який його створив. Всі дозволи та ролі застосовуються.

Управління ключами API

Створити ключ API Auth required

POST /api-keys

Створіть новий ключ API. Сирий ключ повертається ТІЛЬКИ у цій відповіді — зберігайте його надійно.

key також можна отримати пізніше через ендпоїнт Отримати ключ.

Тіло запиту

Відповідь

{
  "apiKey": {
    "id": "k5Xz9qR2Wp",
    "name": "My Script",
    "prefix": "fnp_a1b2",
    "key": "fnp_a1b2c3d4e5f6789012345678901234567890abcdef1234567890abcdef12345678",
    "isActive": true,
    "lastAccessAt": null,
    "expiresAt": "2027-01-01T00:00:00.000Z",
    "createdAt": "2026-03-20T10:00:00.000Z"
  },
  "message": "api_key.created"
}

Переглянути список ключів API Auth required

GET /api-keys

Перегляньте всі ключі API для поточного користувача.

key дорівнює null для ключів, створених до додавання шифрування.

Відповідь

{
  "apiKeys": [
    {
      "id": "k5Xz9qR2Wp",
      "name": "My Script",
      "prefix": "fnp_a1b2",
      "key": "fnp_a1b2c3d4e5f6789012345678901234567890abcdef1234567890abcdef12345678",
      "isActive": true,
      "lastAccessAt": "2026-03-20T14:30:00.000Z",
      "expiresAt": "2027-01-01T00:00:00.000Z",
      "createdAt": "2026-03-20T10:00:00.000Z"
    },
    ...
  ]
}

Отримати ключ Auth required

GET /api-keys/:id/key

Отримайте збережений сирий ключ для існуючого ключа API.

key може бути null для ключів, створених до додавання цієї функції.

Відповідь

{
  "id": "k5Xz9qR2Wp",
  "key": "fnp_a1b2c3d4e5f6789012345678901234567890abcdef1234567890abcdef12345678"
}

Відкликати ключ API Auth required

PATCH /api-keys/:id/revoke

Відкликати (деактивувати) ключ API. Ключ перестає працювати миттєво.

Відповідь

{ "message": "api_key.revoked" }

Видалити ключ API Auth required

DELETE /api-keys/:id

Постійно видалити ключ API.

Відповідь

{ "message": "api_key.deleted" }

Коди помилок

Для загального формату помилок дивіться API General.