Перейти к основному содержимому

Аутентификация

Работа с API-ключами​

Для аутентификации при работе с API scriptRun требуются API-ключи. Каждый API-запрос должен включать API-ключ в заголовках запроса для обеспечения безопасного взаимодействия между клиентом и бэкендом.

Чтобы использовать API-ключ, добавьте следующий заголовок в свои запросы:

X-API-Key: {api_key}

Вы можете создать API-ключ через пользовательский интерфейс, как показано ниже, или обратившись к соответствующим эндпоинтам.

Шаги для создания API-ключа​

1. Откройте свой профиль​

Перейдите в профиль, нажав на иконку пользователя в правом верхнем углу страницы.

Profile Navigation Create API Key

2. Просмотр ваших API-ключей​

После создания ваши API-ключи будут отображены в списке. Вы можете управлять ими (удалять) по мере необходимости.

API Key List

3. Создание API-ключа​

В разделе "API keys" вашего профиля нажмите кнопку "Create API Key".

API Key List

4. Скопируйте ваш API-ключ​

API Key List

Лимиты запросов​

Каждый API-ключ привязан к профилю пользователя и может быть настроен с лимитами запросов. Эти лимиты контролируют, сколько запросов может выполнить API-ключ за определённый период времени.

Лимиты запросов задаются следующим образом:

  • Лимит по умолчанию — 60 запросов в минуту

Чтобы получить разрешение на отправку запросов через API, необходимо запросить разрешение у ваших администраторов. Для получения доступа и дополнительной информации посетите наш канал в Telegram или напишите на support@scriptrun.ai

Пример использования​

Этот заголовок нужно включать в каждый запрос:

X-API-Key: <Your_API_Key>
Shell
curl -X GET https://scriptrun.ai/api/v1/projects/ \
  -H 'Accept: application/json' \
  -H 'X-Api-Key: <Your API Key>'
Python
import requests

headers = {
    'Accept': 'application/json',
    'x-api-key': '<Your API Key>'
}

r = requests.get('https://scriptrun.ai/api/v1/projects/', headers=headers)

print(r.json())

При выполнении API-запросов с использованием вашего API-ключа обязательно включайте заголовок X-API-Key в каждый запрос.