Chaves

Atualizada

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

nome tipo descrição
id ID da chave Identificador de recursos.
resource string, sempre key Especificador de tipo de recurso.
organisation ID da organização A organização a que esta chave pertence.
type corda Um dos: standard , trial .
storage_config ID de configuração de armazenamento opcional A configuração de armazenamento usada pela chave.
webhook_config opcional, ID de configuração do webhook A configuração do webhook usada pela chave.
token corda O material de autenticação para essa chave. É usado para preencher o cabeçalho HTTP de AUTHORIZATION em solicitações na API.
state corda Um de: active , deactivated , blocked , expired .
date_created data hora Quando o recurso foi criado.
date_expires opcional, datetime Quando a chave irá expirar. Aplica-se principalmente às chaves de tipo de trial .

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çõ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

nome tipo descrição
storage_config ID de configuração de armazenamento Substituir a configuração de armazenamento padrão da organização nessa chave.
webhook_config ID de configuração da webhook Substituir a configuração do webhook padrão da organização nessa chave.

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

nome tipo descrição
type corda Filtrar chaves pelo seu tipo.
state corda Filtrar chaves pelo seu estado.

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

nome tipo descrição
storage_config ID de configuração de armazenamento Atualize a configuração de armazenamento usada pela chave. Se null irá retornar ao padrão da organização.
webhook_config ID de configuração da webhook Atualize a configuração do webhook usada pela chave. Se null irá retornar ao padrão da organização.

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

nome tipo descrição
force bool, padrão: False Se o valor atual do token deve ser desautorizado imediatamente. Caso contrário, o período de rotação atual é de 6 horas após a realização da chamada.

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

Como podemos ajudar?

Nossa equipe de suporte está aqui para ajudar!

Nosso horário de atendimento é de segunda a sexta, das 9h às 17h GMT. A hora é atualmente 12:54 AM GMT.

Nosso objetivo é responder a todas as mensagens dentro de um dia útil.

Vá para a seção de apoio › Entre em contato com a equipe da empresa ›
Nossa equipe de suporte incrível

© 2008 - 2019 Reincubate Ltd. Todos os direitos reservados. Registrado na Inglaterra e no País de Gales #5189175, VAT GB151788978. Reincubate® é uma marca registrada. Privacidade e Termos. Recomendamos 2FA. Construído com em Londres.