Ключи

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

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

Атрибуты

Типы

standard

тип ключа. У каждой организации есть хотя бы один из них.

trial

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

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

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

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

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

Токен

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

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

высказывать

active

стандартное состояние ключа.

deactivated

организация-владелец отключила ключ.

blocked

ключ был отключен администратором API.

expired

ключ отключен, поскольку пробный период прошел.

Создать POST /keys

параметры

Использование 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

параметры

Использование 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}

параметры

Использование 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 был взломан.

параметры

Использование 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()