Ключи

обновленный
Cover image for: Ключи

Ключ дает доступ к API на уровне организации через его атрибут token . Разрешено взаимодействовать со всеми конечными точками API от имени своей организации.

Ключ генерируется для каждой вновь созданной организации.

Атрибуты

название тип описание
id идентификатор ключа Идентификатор ресурса.
resource строка, всегда key Спецификатор типа ресурса.
organisation идентификатор организации Организация, которой принадлежит этот ключ.
type строка Один из: standard , trial .
config вложенный объект Параметры конфигурации для конкретных ключей.
storage_config опционально, идентификатор конфигурации хранилища Конфигурация хранилища, используемая ключом.
webhook_config необязательно, идентификатор конфигурации webhook Конфиг webhook, используемый ключом.
token строка Подлинный материал для этого ключа. Используется для заполнения HTTP-заголовка AUTHORIZATION в запросах к API.
state строка Один из: active , deactivated , blocked , expired .
date_created Дата и время Когда ресурс был создан.
date_expires необязательно, дата и время Когда срок действия ключа истечет. В основном относится к ключам trial типа.

Типы

standard
тип ключа. У каждой организации есть хотя бы один из них.
trial
ключ, сгенерированный администратором API, чтобы предоставить организации пробный доступ к дополнительным разрешениям. В них обычно будет date_expires поле date_expires .

Конфигурация

Конфигурация на уровне ключа может быть установлена в атрибуте config ключа. На данный момент это принимает только publish_source_files , связанные с механизмом публикации исходных файлов .

Конфигурации хранилища и веб-перехватчика

Ключевой ресурс может переопределить значения по умолчанию организации для хранилища и конфигурации webhook. Это может быть полезно для разделения результатов и уведомлений о событиях между средами, такими как dev и production.

Токен

Значение атрибута token ключа можно использовать для аутентификации в API от имени организации-владельца.

Эти значения должны храниться надежно и никогда не подвергаться публичному раскрытию.

высказывать

active
стандартное состояние ключа.
deactivated
организация-владелец отключила ключ.
blocked
ключ был отключен администратором API.
expired
ключ отключен, поскольку пробный период прошел.

Создать POST /keys

параметры

имя тип описание
storage_config идентификатор конфигурации хранилища Переопределите конфигурацию хранилища организации по умолчанию для этого ключа.
webhook_config идентификатор конфигурации вебхука Переопределите конфигурацию веб-перехватчика организации по умолчанию для этого ключа.

Использование cURL

curl 'https://ricloud-api.reincubate.com/keys' \
  -X POST \
  -H 'Authorization: Token <your key_token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "storage_config": 2,
}'

Использование ricloud-py

import ricloud

key = ricloud.Key.create(storage_config=2)

# OR

storage_config = ricloud.StorageConfig.retrieve(2)

key = ricloud.Key.create(storage_config=storage_config)

Получить GET /keys/{key ID}

Использование cURL

curl 'https://ricloud-api.reincubate.com/keys/<key ID>' \
  -H 'Authorization: Token <your key_token>'

Использование ricloud-py

import ricloud

key = ricloud.Key.retrieve(<key ID>)

Список GET /keys

параметры

имя тип описание
type нить Фильтровать ключи по их типу.
state нить Фильтровать ключи по их состоянию.

Использование cURL

curl 'https://ricloud-api.reincubate.com/keys?limit=2' \
  -H 'Authorization: Token <your key_token>'

Использование ricloud-py

import ricloud

keys = ricloud.Key.list(limit=2)

Обновить POST /keys/{key ID}

параметры

имя тип описание
storage_config идентификатор конфигурации хранилища Обновите конфигурацию хранилища, используемую ключом. Если значение null будет возвращено к стандартному значению организации.
webhook_config идентификатор конфигурации вебхука Обновите конфигурацию веб-перехватчика, используемую ключом. Если значение null будет возвращено к стандартному значению организации.

Использование cURL

curl 'https://ricloud-api.reincubate.com/keys/<key ID>' \
  -X POST \
  -H 'Authorization: Token <your key_token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "webhook_config": 2
}'

Использование ricloud-py

import ricloud

key = ricloud.Key.update_with_id(<key ID>, webhook_config=2)

# OR

key = ricloud.Key.retrieve(<key ID>)

key.update(webhook_config=2)

Повернуть POST /keys/{key ID}/rotate

Поверните значение ключа token . Хотя это и не требуется, рекомендуется делать это на достаточно регулярной основе , либо сразу же , если есть подозрение в ключа token был взломан.

параметры

имя тип описание
force логическое значение, по умолчанию: False Если текущее значение token должно быть немедленно деавторизовано. Если нет, текущий период ротации составляет 6 часов после совершения звонка.

Использование cURL

curl 'https://ricloud-api.reincubate.com/keys/<key ID>/rotate' \
  -X POST \
  -H 'Authorization: Token <your key_token>'

Использование ricloud-py

import ricloud

key = ricloud.Key.rotate_with_id(<key ID>)

# OR

key = ricloud.Key.retrieve(<key ID>)

key.rotate()

Как мы можем помочь?

Наша служба поддержки здесь, чтобы помочь!

Наш офис работает с понедельника по пятницу с 9:00 до 17:00 по Гринвичу. Время в настоящее время 6:18 ПП с GMT.

Мы стремимся отвечать на все сообщения в течение одного рабочего дня.

Наша отличная команда поддержки

© 2008 - 2023 Reincubate Ltd. Все права защищены. Зарегистрировано в Англии и Уэльсе #5189175, VAT GB151788978. Reincubate® и Camo® являются зарегистрированными товарными знаками. Политика конфиденциальности & условия. Построен с в Лондоне.