Instant API: modo não persistente

O Instant API, ou modo de operação não persistente, foi introduzido na API 6.0.1. É um modo em que não salvamos nenhum dado em lugar nenhum. Todos os dados são usados apenas dentro de uma solicitação: você os envia, recebe a resposta e é só isso, nada fica registrado. Isso garante que nenhum dado sensível seja armazenado, o que pode ser crucial para a conformidade com o GDPR. Além disso, reduz significativamente os requisitos de armazenamento.

Para habilitar este modo, ao preparar o arquivo config.py para executar a API, defina o OZ_APP_COMPONENTS parâmetro para sem estado. Chame POST /api/instant/folders/ para enviar a solicitação sem salvar nenhum dado. A autorização para o Instant API deve ser configurada do seu lado.

Observe: como o Instant API não armazena dados, ele não foi projetado para funcionar com Blacklist (1:N).

Se você usar o Instant API com Web SDK, no Web Adapter configuração, defina architecture como lite. A versão do Web SDK deve ser 1.7.14 ou superior.

Requisitos

• CPU: 16 núcleos, 32 threads, frequência base – 2,3 GHz, frequência turbo máxima de núcleo único – 4 GHz.

• RAM: 32 GB, DDR 5, Dual Channel.

Para avaliar seu RPS e RPM e configurar seu sistema para desempenho ideal, entre em contato conosco.

Parâmetros do arquivo de configuração

Antes do lançamento, prepare um arquivo de configuração com os parâmetros listados abaixo.

Parâmetros obrigatórios

Esses parâmetros são cruciais para executar o Instant API.

# lista de componentes da aplicação, valores para Instant API: auth,stateless
# auth é para o componente de autenticação Oz
OZ_APP_COMPONENTS=stateless
# habilitar suporte a armazenamento local
OZ_LOCAL_STORAGE_SUPPORT_ENABLE=false
# host do serviço tfss
OZ_SERVICE_TFSS_HOST=http://xxx.xxx.xxx.xxx:xxxx
# hosts permitidos
APP_ALLOWED_HOSTS=example-host1.com,example-host2.com
# chave secreta
OZ_API_SECRET_KEY=long_secret_key

Instalação

Docker

CONTAINER_NAME=<container name> \\
DEPLOY_INSTANT_PORT_EXT=<external port> \\
INSTANT_IMAGE=<provided image name> \\
ADDITIONAL_PARAMS="-e LICENSE_KEY=<your license key>" \\

docker run -d --name $CONTAINER_NAME
      $ADDITIONAL_PARAMS
      -p ${DEPLOY_INSTANT_PORT_EXT}:8080
      $INSTANT_IMAGE

Docker Compose

services:
  oz-api-instant:
    image: <provided image>
    container_name: oz-api-instant
    environment:
        - LICENSE_KEY=<your license key>
        # - TF_ENABLE_ONEDNN_OPTS=1 # Em alguns casos, especialmente para CPUs AMD, defina como 0
        # - API_LISTEN_PORT=8080
        # - LOG_LEVEL=info # ['critical', 'error', 'warning', 'info', 'debug', 'trace']
    restart: always
    ports:
      - 8080:8080

Métodos do Instant API

Você pode encontrar os métodos do Instant API aqui ou baixar a COLLECTION abaixo.

OZ-Forensic Instant 6.0.0.postman_collection.json

10KB

Abrir