For the complete documentation index, see llms.txt. This page is also available as Markdown.

OzCapsula Data Container

Configurando Oz API

A principal mudança na interação com a API é que é necessário enviar dados com outro tipo de conteúdo, pois o contêiner de dados é um arquivo binário: Content-Type = application/octet-stream. Foi adicionada compatibilidade com esse tipo de conteúdo, juntamente com a funcionalidade de contêiner.

Além disso, Instant API agora requer as chaves privada e pública do cliente para funcionar. Os caminhos para essas chaves devem ser especificados em OZ_JWT_PRIVATE_KEY_PATH e OZ_JWT_PUBLIC_KEY_PATH no arquivo de configuração.

Para gerá-las, use os comandos listados abaixo.

# Gerar chave privada:
openssl ecparam -name secp384r1 -genkey -noout | openssl pkcs8 -topk8 -nocrypt -out ./jwt.key
# Gerar chave pública:
openssl ec -in ./jwt.key -pubout -out ./jwt.pub

Parâmetros de configuração

Esses parâmetros são obrigatórios para o funcionamento do OzCapsula. Adicione-os ao arquivo de configuração.

Exemplos

Observe: atualmente, o contêiner funciona com modo de solicitação única apenas.

POST api/folders:

POST api/instant/folders:

Exceções

Código de erro

Mensagem de erro

Descrição

3

Dados da solicitação inválidos

payload.json ausente

4

Dados da solicitação inválidos

Nenhuma mídia foi adicionada ao contêiner

5

Dados da solicitação inválidos

Contêiner danificado

13

Dados da solicitação inválidos

A API não recebeu o contêiner

14

Dados da solicitação inválidos

O contêiner parece estar afetado por erros e não pode ser descompactado.

Obtendo um token de sessão

Antes de começar com o SDK, obtenha um token de sessão:

  1. (Opcional, somente se usar a API stateful) Autorize-se como qualquer função diferente de OPERATOR.

  2. Chame GET {{host}}/api/authorize/session_token.

Exemplo de solicitação

Exemplo de resposta

Atualizado

Isto foi útil?