Oystr Vault Documentation

Introdução

As senhas e certificados, referidos daqui em diante pelo termo 'credenciais', que são utilizados pelos robôs da Oystr ficam gravadas em um banco de dados seguro chamado Vault. O Vault garante a segurança no armazenamento e acesso às credenciais, evitando que ocorra o acesso indevido à uma determinada credencial.

Token de Acesso

Para interagir com o Vault via api http é necessário criar um chave ou token de acesso à API. Para criar o token de acesso acesse a opção Configurações API no painel de controle da Oystr e clique no botão "Criar chave de integração".

A chave é um token jwt que contém informações relacionadas à sua conta e usuário na Oystr. Todas as requisições realizadas pela api devem, necessariamente, utilizar um token de acesso válido. O token deve ser passado como o valor do header X-Oystr-Auth

Para testar os exemplos abaixo insira seu token aqui:

API HTTP

A url base para às chamadas da api é https://api4.oystr.com.br/v1.

Aviso: a url base pode mudar nas próximas versões da api

As seguintes operações relacionadas credenciais estão disponíveis

Listagem de Credenciais

Para listar as credenciais existentes utilize o path /secrets conforme o exemplo abaixo: 

curl https://api4.oystr.com.br/v1/secrets?format=v2 -H X-Oystr-Auth:SEU_TOKEN_AQUI

A chamada acima retorna a lista de credenciais em json. O formato do payload é:

Nome Tipo Descrição
id número|int ID da credencial (uso interno)
name string Nome da credencial
kind enum Tipo da credencial (detalhes abaixo)
hash string Hash que identifica a credencial
created timestamp Data de criação da credencial
labels array Robôs que tem acesso à credencial

Tipos de Credencial

Cada credencial tem um tipo associado. Os tipos são os seguintes:

Código Tipo Formato JSON
up usuário e senha 
{
 "username": "string",
 "password": "string"
}
cp certificado e pin 
{
 "username": "string",
 "pin": "string",
 "base64Cert": "string"
}
 base64Cert: é o conteúdo do certificado em base64
upcp usuário, senha, certificado e pin 
{
 "username": "string",
 "password": "string",
 "pin": "string",
 "base64Cert": "string"
}
 base64Cert: é o conteúdo do certificado em base64

Labels

Cada credencial pode ter um conjunto de labels associado. Existem vários tipos de labels, o tipo mais comum é o label bot, indicando quais robôs estão associados à esta credencial.

Criação de uma nova credencial

Para cadastrar uma nova credencial utilize o path /secret conforme o exemplo abaixo: 

curl -X POST https://api4.oystr.com.br/v1/secret -d '{}' -H X-Oystr-Auth:SEU_TOKEN_AQUI -H Content-Type:application/json

Obtenção de uma credencial

Para obter o conteúdo de uma credencial existente utilize o path /secret/:hash conforme o exemplo abaixo: 

curl https://api4.oystr.com.br/v1/secret/HASH -H X-Oystr-Auth:SEU_TOKEN_AQUI

A chamada acima retorna o conteúdo da credencial em json, o formato pode variar dependendo do Tipo da Credencial. o payload poderá ser:

Código Tipo Formato JSON
up usuário e senha 
{
 "username": "string",
 "password": "string"
}
cp certificado e pin 
{
 "username": "string",
 "pin": "string",
 "base64Cert": "string"
}
 base64Cert: é o conteúdo do certificado em base64
upcp usuário, senha, certificado e pin 
{
 "username": "string",
 "password": "string",
 "pin": "string",
 "base64Cert": "string"
}
 base64Cert: é o conteúdo do certificado em base64

Remoção de uma credencial

Para remoção de uma credencial existente utilize o path /secret/:hash conforme o exemplo abaixo: 

curl -X DELETE https://api4.oystr.com.br/v1/secret/HASH -H X-Oystr-Auth:SEU_TOKEN_AQUI

Atualização de uma credencial

Para atualizar uma credencial, utilize o path /secret/:hash conforme o exemplo abaixo utilizando o mesmo tipo de credencial que foi cadastrada: 

curl -X PUT https://api4.oystr.com.br/v1/secret/HASH -d '{}' -H X-Oystr-Auth:SEU_TOKEN_AQUI -H Content-Type:application/json