Tokens

Links de compartilhamento de arquivos (tokens com validade).

Classe Tokens: 5 métodos (0 no @owbase/web, 5 no @owbase/node). Os exemplos usam a forma de objeto dos parâmetros; troque os valores entre < e > pelos seus.

list

Listar tokens

SDK: só @owbase/node

Lista todos os tokens criados para um arquivo ou bucket. Use os parâmetros de consulta para filtrar os resultados.

Parâmetro	Tipo	Obrigatório	Descrição
bucketId	string	sim	ID único do bucket de storage. Você pode criar um bucket com a integração de servidor do serviço Storage.
fileId	string	sim	ID único do arquivo.
queries	string[]	não	Lista de consultas geradas com a classe Query do SDK. Saiba mais sobre consultas. No máximo 100 consultas, cada uma com até 4096 caracteres. É possível filtrar pelos atributos: expire
total	boolean	não	Com false, o total não é calculado e volta como 0.

Acesso: chave de API com o escopo tokens.read.

@owbase/node

import { Client, Tokens } from '@owbase/node';

const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)

const tokens = new Tokens(client);

const result = await tokens.list({
    bucketId: '<BUCKET_ID>',
    fileId: '<FILE_ID>',
    queries: [], // opcional
    total: false, // opcional
});

createFileToken

Criar token de arquivo

SDK: só @owbase/node

Cria um token. O token fica ligado a um arquivo e pode ser passado como parâmetro de busca na URL do pedido.

Parâmetro	Tipo	Obrigatório	Descrição
bucketId	string	sim	ID único do bucket de storage. Você pode criar um bucket com a integração de servidor do serviço Storage.
fileId	string	sim	ID único do arquivo.
expire	string	não	Data de expiração do token

Acesso: chave de API com o escopo tokens.write.

@owbase/node

import { Client, Tokens } from '@owbase/node';

const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)

const tokens = new Tokens(client);

const result = await tokens.createFileToken({
    bucketId: '<BUCKET_ID>',
    fileId: '<FILE_ID>',
    expire: '2020-10-15T06:38:00.000+00:00', // opcional
});

get

Obter token

SDK: só @owbase/node

Obtém um token pelo ID.

Parâmetro	Tipo	Obrigatório	Descrição
tokenId	string	sim	ID do token.

Acesso: chave de API com o escopo tokens.read.

@owbase/node

import { Client, Tokens } from '@owbase/node';

const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)

const tokens = new Tokens(client);

const result = await tokens.get({
    tokenId: '<TOKEN_ID>',
});

update

Atualizar token

SDK: só @owbase/node

Atualiza um token pelo ID. Use este endpoint para atualizar a data de expiração de um token.

Parâmetro	Tipo	Obrigatório	Descrição
tokenId	string	sim	ID único do token.
expire	string	não	Data de expiração do token de arquivo

Acesso: chave de API com o escopo tokens.write.

@owbase/node

import { Client, Tokens } from '@owbase/node';

const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)

const tokens = new Tokens(client);

const result = await tokens.update({
    tokenId: '<TOKEN_ID>',
    expire: '2020-10-15T06:38:00.000+00:00', // opcional
});

delete

Excluir token

SDK: só @owbase/node

Exclui um token pelo ID.

Parâmetro	Tipo	Obrigatório	Descrição
tokenId	string	sim	ID do token.

Acesso: chave de API com o escopo tokens.write.

@owbase/node

import { Client, Tokens } from '@owbase/node';

const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)

const tokens = new Tokens(client);

const result = await tokens.delete({
    tokenId: '<TOKEN_ID>',
});

---

As descrições desta página são traduções das que vêm da especificação da API do servidor (licença BSD-3-Clause), e os exemplos vêm do gerador de SDKs (licença MIT). Os avisos completos estão no arquivo NOTICE dos pacotes @owbase/web e @owbase/node.