Аутентификация
Аутентифицируйтесь с помощью ключа API, полученного после оплаты.
После доставки ручной настройки используйте OpenAI-совместимый ключ API и базовый URL из доверенного серверного кода. Не допускайте доступа учетных данных к клиентам, а затем меняйте или отзывайте ключи с заданной областью, не нарушая работу несвязанных служб.
Последнее обновление: July 12, 2026. Examples использование safe placeholders и сделать не включить real credentials или customer данные.
Правило на стороне сервера
Относитесь к доставленным ключам API как к производственным учетным данным. Храните их в доверенных серверных средах и вызывайте собственный бэкэнд из браузеров или мобильных приложений.
Путь установки
Шесть шагов от ручной доставки до безопасного вращения.
Step 1
Получите настройку API
Завершите оплату пакета и подождите от 10 минут до 5 часов, пока администратор доставит ключ API, базовый URL, установочные файлы, дату активации, дату начала и дату окончания.
Step 2
Создать ключ с областью действия
После завершения установки сохраните доставленный ключ на стороне сервера или создайте ключ с ограниченной областью для одной службы, одной среды и наименьших областей конечных точек, необходимых службе.
Step 3
Храните его на стороне сервера
Сохраните полное значение в секретном менеджере или переменной среды развертывания. Не отправляйте его в браузеры или мобильные клиенты.
Step 4
Отправить токен на предъявителя
Прикрепите ключ в заголовке авторизации для каждого запроса на стороне сервера к доставленной OpenAI-совместимой базе API URL.
Step 5
Следите за ошибками аутентификации
Используйте стабильные коды ошибок, чтобы различать отсутствующие ключи, неактивные ключи, ключи с истекшим сроком действия, сбои политики IP и отсутствующие области.
Step 6
Ротация до того, как риск вырастет
Создайте замещающий ключ, разверните его, подтвердите перемещение трафика, а затем отзовите старый ключ.
API формат ключа
Ключи идентифицируют окружающую среду и секретный материал отдельно.
Ключ API, доставленный вручную, приходит только по электронной почте. Ключи области самообслуживания начинаются с префикса unlimitedcodex, включают сегмент среды и заканчиваются сгенерированным секретным материалом; их полная стоимость отображается один раз при создании.
| Сегмент | Пример | Цель |
|---|---|---|
| Префикс | ucx | Идентифицирует значение как ключ unlimitedcodex API. |
| Окружающая среда | разработка, тестирование или работа в реальном времени | Разделяет локальные, промежуточные и производственные учетные данные. |
| Секретное значение | Сгенерированное случайное значение | Отображается один раз при создании, а затем сохраняется как безопасный хэш. |
| Отображаемый префикс | Первые безопасные персонажи | Используется в журналах и информационных панелях для идентификации ключа без раскрытия полных учетных данных. |
Use placeholders such as ucx_live_placeholder_value в документы и tests. Никогда вставить a real ключ в examples, проблема trackers, analytics, или поддержка messages.
Использование токена на предъявителя
Отправьте ключ в заголовке Authorization.
Вызывающие стороны на стороне сервера должны прочитать доставленный или ограниченный ключ из переменной среды и отправить его как токен носителя с каждым запросом API.
Используйте HTTPS для всех запросов API.
Полный ключ отправляйте только в заголовке Authorization.
Держите заголовки типов контента отдельно от аутентификации.
Возвращайте очищенные ошибки клиентским приложениям.
# Server-side environment only UCX_API_KEY=ucx_live_placeholder_value
const response = await fetch("https://unlimitedcodex.com/v1/models", {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.UCX_API_KEY}`
}
});
if (!response.ok) {
const error = await response.json();
throw new Error(error.error?.code ?? "api_request_failed");
}Переменные среды
Не допускайте попадания учетных данных в клиентские пакеты.
Доставленные ключи API принадлежат серверным процессам, бессерверным функциям и защищенным рабочим процессам. Код браузера должен вызывать ваш сервер, а не unlimitedcodex напрямую.
Местное развитие
Используйте ключ разработки или тестирования в локальном файле env, который игнорируется git.
Предварительный просмотр развертываний
Используйте отдельный ключ предварительного просмотра, чтобы промежуточный трафик не повлиял на рабочие учетные данные.
Производственные серверы
Используйте хранилище зашифрованной среды вашего хостинг-провайдера или специальный секретный менеджер.
Клиентские приложения
Не раскрывайте ключи API в переменных среды внешнего интерфейса, хранилище браузера, мобильных пакетах или статических файлах.
Ключевое вращение
Ротация: сначала добавляйте, а затем отменяйте.
Избегайте перерывов в производстве, развернув заменяющий ключ перед отзывом старого. Используйте префиксы отображения и запрашивайте журналы для подтверждения переключения.
# Rotation checklist 1. Create a replacement key with the same required scopes. 2. Save it as the next server-side environment value. 3. Deploy the service and confirm traffic uses the new prefix. 4. Revoke the old key after traffic has moved. 5. Monitor 401 and 403 responses for stale deployments.
Распространенные ошибки авторизации
Прежде чем повторить попытку, прочтите статус и код ошибки.
При ошибках аутентификации используются стабильные коды ответа, поэтому ваша интеграция может отличать отсутствующие учетные данные от проблем с областью, статусом, белым списком и проверкой.
| Статус | Код | Общая причина | Следующее действие |
|---|---|---|---|
| 401 | valid_api_key | Заголовок авторизации отсутствует, имеет неверный формат или содержит неизвестный ключ. | Проверьте токен носителя, имя переменной среды и секрет развертывания. |
| 403 | inactive_api_key | Ключ существует, но не активен. | Используйте активный ключ или создайте замещающий ключ для службы. |
| 403 | expired_api_key | Срок действия ключа истек. | Поверните учетные данные и разверните новое значение. |
| 403 | ip_not_allowed | Запрос поступил с IP-адреса, не входящего в список разрешенных ключей. | Обновите белый список или отправьте трафик с одобренного сервера. |
| 403 | недостаточный_объем | Ключ не включает область, требуемую конечной точкой. | Создайте или обновите ключ с определенной областью, необходимой вашей конечной точке. |
| 503 | api_key_store_unavailable | Проверка ключей на основе базы данных временно недоступна или не настроена. | В случае временных сбоев повторите попытку позже или проверьте конфигурацию среды в непроизводственных средах. |
Рекомендуемые меры безопасности
Разработайте аутентификацию для сдерживания.
Хорошая ключевая стратегия ограничивает радиус ошибок. Разделяйте среды, области, службы и владельцев, чтобы у одного ключа никогда не было большего доступа, чем ему необходимо.
Используйте отдельные ключи для разработки, подготовки и производства.
Создайте один ключ для каждой службы, чтобы обеспечить ротацию и отзыв.
Предоставляйте только те области конечных точек, которые необходимы службе.
Не допускайте попадания ключей в клиентский код, мобильные приложения, журналы и общедоступные репозитории.
Сохраните полный ключ в секретном менеджере или переменной среды развертывания.
Меняйте ключи по расписанию и сразу после подозрения на заражение.
FAQ
Вопросы аутентификации.
Получу ли я ключ API сразу после оформления заказа?
Нет. Настройка производится вручную после оплаты. Ожидаемая доставка занимает от 10 минут до 5 часов и включает ключ API, базовый URL, файлы установки, дату активации, дату начала и дату окончания.
Где мне следует хранить ключ API?
Сохраните полный ключ в диспетчере секретов на стороне сервера или в переменной среды развертывания. Никогда не размещайте его в коде браузера, мобильных приложениях, общедоступных репозиториях или в конфигурации, видимой клиенту.
Могу ли я вставить настоящий ключ API в бесплатные инструменты или формы поддержки?
Нет. Используйте заполнители или проверенные примеры в бесплатных инструментах, формах поддержки, средствах отслеживания проблем, аналитике и общих журналах. Храните полные ключи API, заголовки авторизации, скриншоты счетов, конфиденциальные полезные данные и регулируемые данные вдали от общедоступных или полупубличных поверхностей.
Могу ли я просмотреть полный ключ API после создания?
Нет. Ключ API, доставленный вручную, приходит только по электронной почте. Ключи области самообслуживания отображаются один раз при создании; после этого используйте префикс безопасного отображения, пока платформа сохраняет безопасный хеш.
Какие области действия может использовать ключ?
Ключи API могут иметь область действия: чат:запись, встраивание:запись, изображения:запись и использование:чтение. Предоставьте наименьший набор областей, необходимый службе.
Как повернуть рабочий ключ?
Создайте замещающий ключ с необходимыми областями, разверните его как новое значение среды на стороне сервера, подтвердите, что трафик использует новый префикс, а затем отзовите старый ключ.
Бесплатные инструменты
Попробуйте это перед первым запросом в реальном времени.
Помощники на стороне клиента для миграции, проверки, планирования квот и устранения ошибок 429.
Генератор миграции
Сгенерируйте или преобразуйте фрагменты OpenAI SDK в базу unlimitedcodex URL, ключи и области действия.
Запросить валидатор
Проверьте полезные данные чата, встраивания и изображений JSON на соответствие правилам, совместимым с unlimitedcodex OpenAI.
429 Декодер
Вставьте тело ответа 429 и заголовки, чтобы классифицировать ограничение скорости и давление квоты и просмотреть рекомендации по повторной попытке.
Конфигуратор области
Выберите рабочие нагрузки и выведите области с наименьшими привилегиями,.env.example и контрольный список ротации.
Планировщик лимитов ставок
Запланируйте настройки отсрочки и контрольный список мониторинга квот, исходя из ожидаемого RPS и размера команды.
Следующий шаг
Соедините аутентификацию с квотой и обработкой ошибок.
После того как ключи будут на стороне сервера и определены их области, проверьте неограниченное использование токенов, 4 одновременных подключения, распространенные ошибки API и настройку конечной точки веб-перехватчика, прежде чем трафик, ориентированный на клиента, увеличится.