Создать API ключ

Создает новый ключ доступа. Сгенерированный токен имеет префикс `yougpu_sk_` и используется для авторизации всех запросов к API.

POST https://api.yougpu.ru/api-keys

Заголовки (Headers)

Заголовок	Значение	Описание
X-API-KEY	<YOUR_API_KEY>	Ваш API ключ
Content-Type	application/json	Формат данных

Параметры тела (Body)

Параметр

Тип

Описание

name*

string

Название ключа (например, 'CI/CD Pipeline'). Максимум 50 символов.

Примеры кода

curl -X POST "https://api.yougpu.ru/api-keys" \
  -H "X-API-KEY: <YOUR_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "api-test"
  }'

import requests

url = "https://api.yougpu.ru/api-keys"
headers = {
    "X-API-KEY": "<YOUR_API_KEY>",
    "Content-Type": "application/json"
}
data = {
    "name": "api-test"
}

response = requests.post(url, json=data, headers=headers)
print(response.json())

const response = await fetch('https://api.yougpu.ru/api-keys', {
  "method": "POST",
  "headers": {
      "X-API-KEY": "<YOUR_API_KEY>",
      "Content-Type": "application/json"
  },
  "body": JSON.stringify({
      "name": "api-test"
  })
});
const data = await response.json();
console.log(data);

Ответ

201 Created

{
  "status": "success",
  "code": 201,
  "data": {
    "id": "8ffee1f7-98f7-4136-9f76-5c5878852d92",
    "name": "api-key-name",
    "key_prefix": "yougpu_sk_live_NN-p6zMA",
    "secret_key": "yougpu_sk_live_NN-p6zMA_ВЕСЬ_СЕКРЕТНЫЙ_ХЕШ_ЗДЕСЬ",
    "is_active": true,
    "expires_at": null,
    "last_used_at": null,
    "created_at": "2026-02-24T18:46:13.759Z",
    "updated_at": "2026-02-24T18:46:13.759Z"
  }
}

Структура ответа

Параметр

Тип

Описание

status

string

Статус выполнения запроса (например, success).

code

number

HTTP код ответа.

data

object

Данные ответа:

string

Внутренний ID записи ключа.

name

string

Название ключа.

secret_key

string

Полное значение токена. Используйте его в заголовке `X-API-KEY`. Возвращается только один раз при создании.

key_prefix

string

Первые символы ключа для визуальной идентификации в интерфейсе.

is_active

boolean

Текущий статус ключа (true - работает).

expires_at

string | null

Дата истечения срока действия ключа (если задана).

last_used_at

string | null

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

created_at

string

Дата создания ключа в формате ISO 8601.

updated_at

string

Дата последнего обновления информации о ключе.

Есть вопросы?

Поддержка Чат

Нашли ошибку? Сообщить