Chaves

Uma chave fornece acesso à API no nível da organização por meio de seu atributo de token . É permitido interagir com todos os endpoints da API em nome de sua organização.

Uma chave é gerada para cada organização recém-criada.

Atributos

Tipos

standard

o tipo de chave. Toda organização tem pelo menos um deles.

trial

uma chave gerada por um administrador de API para dar acesso de avaliação às permissões adicionais à organização. Normalmente, eles terão o campo date_expires definido.

Configuração

A configuração de nível de chave pode ser definida no atributo de config da chave. No momento, isso aceita apenas publish_source_files , relacionado ao mecanismo de publicação de arquivos de origem .

Configurações de armazenamento e webhook

Um recurso-chave pode substituir os valores padrão da organização para armazenamento e configuração do webhook. Isso pode ser útil para dividir resultados e notificação de eventos entre ambientes como dev e produção.

Símbolo

O valor do atributo de token de uma chave pode ser usado para autenticar a API em nome da organização proprietária.

Esses valores devem ser armazenados com segurança e nunca expostos publicamente.

Estado

active

o estado padrão da chave.

deactivated

a organização proprietária desativou a chave.

blocked

a chave foi desativada por um administrador da API.

expired

a chave é desativada quando o período de avaliação já passou.

Criar POST /keys

Parâmetros

Usando 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,
}'

Usando 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)

Recuperar GET /keys/{key ID}

Usando cURL

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

Usando ricloud-py

import ricloud

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

Listar GET /keys

Parâmetros

Usando cURL

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

Usando ricloud-py

import ricloud

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

Atualizar POST /keys/{key ID}

Parâmetros

Usando 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
}'

Usando 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)

Rodar as POST /keys/{key ID}/rotate

Gire o valor do token de uma chave. Embora não seja obrigatório, é recomendável fazer isso regularmente ou imediatamente se houver suspeita de que o token da chave foi comprometido.

Parâmetros

Usando cURL

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

Usando ricloud-py

import ricloud

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

# OR

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

key.rotate()