# Geral

# Requisitos instalação Onblox

<span dir="ltr" id="bkmrk--1"></span>

## Objetivo

Fornece para o cliente os requisitos necessários para instalação e configuração da plataforma logística da onBlox WMS e TMS.

## Requisitos

- A(s) máquina(s) podem ser física ou virtual (Preferencial VM).

## Sistema Operacional

- Linux (Ubuntu Desktop) com módulo gráfico.

## Processador

- 2 GHz, Cache de 3MB ou superior Mínimo 4 núcleos, preferencial 6 núcleos.

## Memória (RAM)

- Mínimo 16 GB, preferencial 20 GB.

## Disco rígido (Hard Disk)

- 250 GB ou superior.

## Navegadores

- Google Chrome, Mozilla Firefox etc.

## Smartphone ou Coletor de Dados

- Android versão 5.0 ou superior ou Windows Mobile, 2 GB ou superior**.**

## Internet

- Acesso total ou liberado para os seguintes endereços: 
    - [http://onblox.app.br:8081](http://onblox.app.br:8081)
    - [https://hub.docker.com](https://hub.docker.com)

## Banco de Dados

- Para clientes que desejam utilizar Banco de Dados próprio, disponibilizar as configurações de acesso e usuário com privilégios para leitura, escrita, criar tabela, view, trigger, index e funções.

## Acesso

- O acesso externo a máquina pode ser via: 
    - TeamViewer (ID e Senha).
    - SSH (Host Name/IP Address, usuário e Senha).
    - AnyDesk (ID e Senha).

## IP Fixo

- O servidor deverá ser configurado com um IP fixo.

# Utilizando a Base de Conhecimento

## Introdução

A base de conhecimento da Onblox possui diversas funcionalidades para te auxiliar a encontrar as respostas da forma mais rápida e eficiente possível. Nessa página, vamos explorar a estrutura da documentação, assim algumas dessas funcionalidades e como utilizá-las.

---

## Estrutura

A estrutura da documentação é separada em tipos de conteúdos. Os tipos são **Estante**, **Livro**, **Capítulo** e **Página**. Para mais detalhes, clique nas abas abaixo.

<details id="bkmrk-p%C3%A1gina-a%C2%A0p%C3%A1gina-%C3%A9-um"><summary>Página</summary>

A **Página** é um documento de texto, onde a informação é escrita e disponibilizada.

Exemplo: [Usuário](https://docs.onblox.app.br/books/cadastros-wms/page/usuario "Usuário")

</details><details id="bkmrk-cap%C3%ADtulo-o%C2%A0cap%C3%ADtulo%C2%A0"><summary>Capítulo</summary>

O **Capítulo** é uma coleção de **páginas** agrupadas. O capítulo não é obrigatório e costuma ser utilizado caso existam diversas páginas similares mas com informações diferentes.

Exemplo: [Produtos](https://docs.onblox.app.br/books/cadastros-wms/chapter/produtos "Produtos")

</details><details id="bkmrk-livro-o%C2%A0livro-%C3%A9-uma-"><summary>Livro</summary>

O **Livro** é uma coleção de **páginas** e **capítulos** que estejam em um mesmo assunto (Como módulo de sistema). O Livro é obrigatório e todo documento precisa estar contido em um.

Exemplo: [Cadastros](https://docs.onblox.app.br/books/cadastros-wms "Cadastros")

</details><details id="bkmrk-estante-a%C2%A0estante-%C3%A9-"><summary>Estante</summary>

A **Estante** é uma coleção de **livros**. Cada projeto (software) onBlox é separado em uma estante.

Exemplo: [WMS](https://docs.onblox.app.br/shelves/wms "WMS")

</details>---

## Pesquisa

Entre todas as funcionalidades, a pesquisa de documentos é a mais importante. No topo da tela, é possível pesquisar páginas com palavras chaves que ajude a encontrar a solução desejada.

![image.png](https://docs.onblox.app.br/uploads/images/gallery/2024-10/scaled-1680-/wM9image.png)

Ao clicar na barra de pesquisa e digitar algum texto, o site irá retornar páginas, capítulos, livros ou estantes com a informação digitada.

![image.png](https://docs.onblox.app.br/uploads/images/gallery/2024-10/scaled-1680-/ssHimage.png)

A pesquisa desconsidera qualquer acento, caractere especial e letra maiúscula. Ou seja, o texto **instalacao** e **INSTALAÇÃO** são considerados a mesma pesquisa.

Caso precise de mais filtros, pressionando **enter** ou clicando no botão **Visualizar Tudo**, o sistema irá redirecionar para a tela **Pesquisa Avançada**, onde é possível filtrar por data, marcadores, tipo de conteúdo, etc..

![image.png](https://docs.onblox.app.br/uploads/images/gallery/2024-10/scaled-1680-/H5Wimage.png)

---

## Exportar

A funcionalidade de exportar páginas permite salvar e exportar os documentos nos formatos **HTML**, **PDF**, **TXT** e **MD**. Para exportar um documento, selecione o botão **exportar** no menu esquerdo da tela.

![image.png](https://docs.onblox.app.br/uploads/images/gallery/2024-10/scaled-1680-/OKcimage.png)

Após selecionar o formato desejado, o navegador irá baixar o arquivo automaticamente.

<p class="callout info">**Informação:** A opção de exportação pode ser desabilitada em algumas páginas. Caso não encontre o botão, a página atual não permite exportação.</p>

---

## Compartilhar Trecho

A funcionalidade **Compartilhar Trecho** permite selecionar um treco específico da página e gerar um link que redireciona para o trecho selecionado.

Para compartilhar o trecho, selecione uma parte do texto e clique no botão "copiar" (ícone retangular).

![image.png](https://docs.onblox.app.br/uploads/images/gallery/2024-10/scaled-1680-/Dszimage.png)

<p class="callout info">**Informação:** O trecho compartilhado pode ser acessado apenas por usuários que tenham permissão para acessar a página.</p>

---

# API Suite OnBlox — Autenticação por API Token

6 de outubro de 2026 · @Thiago Silva Cruz

**Versão:** 1.0  
**Atualizado em:** 06/10/2026  
**Público:** Parceiros e integradores  
**Escopo:** Autenticação das APIs da Suite OnBlox (`/api/**`)

## 1. Visão geral

Sistemas externos podem consumir as APIs disponibilizadas diretamente pela Suite OnBlox para consultar ou enviar informações, de acordo com os endpoints disponíveis para cada integração.

Toda chamada à API da Suite OnBlox (/api/\*\*) deve incluir o cabeçalho:

```http
X-API-Token:
 onbx_SEU_TOKEN_AQUI

```

O token autentica o sistema externo que está acessando a Suite OnBlox e substitui o uso de usuário e senha nas chamadas da API. Ele é gerado na própria Suite OnBlox pelo administrador do cliente e é válido exclusivamente para o ambiente ao qual pertence.

> **Princípio-chave:** Um token não é uma credencial global da OnBlox. Cada cliente possui sua própria URL base e sua própria credencial.

## 2. Arquitetura da integração

Na versão 1.0, os sistemas externos se comunicam diretamente com as APIs disponibilizadas pela Suite OnBlox .

**Fluxo:** Sistema externo / ERP → Suite OnBlox → /api/\*\*

Se um parceiro integra seu sistema com mais de um cliente OnBlox, deve manter uma configuração independente para cada cliente.

```text
Cliente A  →  URL base A + Token A
Cliente B  →  URL base B + Token B

```

## 3. Início rápido

1. Receba do cliente a URL base da Suite OnBlox.
2. Receba um API Token válido.
3. Configure a URL e o token especificamente para aquele cliente.
4. Utilize um dos endpoints disponibilizados pela OnBlox para a integração.
5. Confirme o retorno HTTP da operação.
6. Implemente o tratamento adequado de erros antes de colocar a integração em produção.

```curl
curl -X GET "https://suite.exemplo.com.br/onblox/api/<endpoint>" \
  -H "X-API-Token: onbx_SEU_TOKEN_AQUI" \
  -H "Accept: application/json"

```

Substitua <endpoint> pelo endpoint disponibilizado para a integração.</endpoint>

## 4. Como obter o token

O token é gerado na Suite OnBlox do cliente. Um administrador deve acessar:

Configuração da conta › Configuração de APIs › Tokens

1. Informar um nome que identifique a integração, com até 60 caracteres.
2. Definir a validade em dias . Valor 0 = sem vencimento.
3. Escolher a permissão: Somente leitura ou Leitura e escrita .
4. Clicar em Gerar token e copiar o valor apresentado.

> **Exibição única:** O token tem prefixo onbx\_ e aparece uma única vez. A Suite OnBlox mantém somente uma representação segura da credencial. Se o token for perdido, gere um novo.

O token herda o usuário que o gerou. Se esse usuário for desativado, o token deixa de funcionar. Recomenda-se utilizar um usuário dedicado à integração . Cada usuário pode possuir até 5 tokens ativos .

## 5. Como enviar o token

Envie o valor puro do token no cabeçalho HTTP X-API-Token , em todas as requisições.

```http
X-API-Token:
 onbx_SEU_TOKEN_AQUI

```

- Não use Authorization: Bearer ... .
- Não envie prefixos adicionais, aspas ou espaços extras.
- Não envie o token na URL, query string, corpo da requisição ou cookies.
- Não há login prévio nem criação de sessão: o token é a própria credencial.

## 6. HTTPS obrigatório

Todas as requisições autenticadas devem utilizar HTTPS.

```text
https://cliente.exemplo.com.br/onblox/api/...

```

> **Importante:** Chamadas autenticadas por HTTP são recusadas.

## 7. Autenticação e autorização

Autenticação verifica se o token apresentado é válido. Autorização determina quais operações esse token pode executar.

<table id="bkmrk-permiss%C3%A3o-get-post-p"><thead><tr><th>Permissão</th><th>GET</th><th>POST</th><th>PUT/PATCH</th><th>DELETE</th></tr></thead><tbody><tr><td>Somente leitura</td><td>Sim</td><td>Não</td><td>Não</td><td>Não</td></tr><tr><td>Leitura e escrita</td><td>Sim</td><td>Sim\*</td><td>Sim\*</td><td>Sim\*</td></tr></tbody></table>

- Quando a respectiva operação existir e estiver disponibilizada pelo endpoint.

## 8. Integrações com múltiplos clientes

A mesma aplicação pode integrar diferentes clientes OnBlox. Cada cliente deve possuir configuração independente.

```json
{
  "cliente": "Cliente Exemplo",
  "baseUrl": "https://cliente.exemplo.com.br/onblox",
  "apiToken": "${ONBLOX_API_TOKEN}"
}

```

> **Isolamento por cliente:** Não utilize um único token global para todos os clientes. Antes de realizar uma chamada, selecione a URL e a credencial correspondentes ao cliente que está sendo processado.

## 9. Erros de autenticação

Recusas de token retornam status HTTP 401 ou 403 . Decida o tratamento pelo status HTTP; o campo message é destinado a pessoas e não deve ser usado como condição no código.

<table id="bkmrk-status-mensagem-caus"><thead><tr><th>Status</th><th>Mensagem</th><th>Causa</th><th>O que fazer</th></tr></thead><tbody><tr><td>401</td><td>Token de API ausente. Informe o cabeçalho X-API-Token.</td><td>Cabeçalho ausente ou vazio</td><td>Enviar X-API-Token em toda chamada</td></tr><tr><td>401</td><td>Token de API inválido.</td><td>Valor incorreto, cortado ou de outro cliente</td><td>Conferir token e endereço da Suite OnBlox</td></tr><tr><td>401</td><td>Token de API revogado. Gere um novo token na Suite OnBlox.</td><td>Token revogado pelo cliente</td><td>Solicitar novo token</td></tr><tr><td>401</td><td>Token de API vencido. Gere um novo token na Suite OnBlox.</td><td>Validade expirada</td><td>Solicitar novo token</td></tr><tr><td>401</td><td>O usuário dono deste token está desativado.</td><td>Usuário que gerou o token foi desativado</td><td>Reativar usuário ou gerar token por outro usuário</td></tr><tr><td>401</td><td>Esta API exige HTTPS.</td><td>Chamada feita via HTTP</td><td>Utilizar HTTPS</td></tr><tr><td>403</td><td>Este token é somente de leitura e não pode executar a operação.</td><td>Token sem permissão de escrita</td><td>Solicitar token com leitura e escrita</td></tr></tbody></table>

> **Retry:** Não repita automaticamente chamadas que receberam 401 ou 403: o problema está na credencial ou permissão e não se resolve com nova tentativa.

## 10. Segurança

- Armazene o token em variável de ambiente ou cofre de segredos.
- Nunca inclua o token no código-fonte ou em repositórios Git.
- Não registre o token em logs ou mensagens de erro.
- Utilize um token diferente para cada integração/sistema.
- Conceda somente a permissão necessária.
- Use um usuário dedicado para integrações.
- Se houver suspeita de vazamento, revogue a credencial imediatamente.

> **Entrega segura:** Prefira cofre de senhas, gerenciador de segredos ou link de uso único. Evite enviar tokens por e-mail, chat, planilhas ou tickets.

## 11. Rotação do token

Gerar um novo token não revoga automaticamente os tokens existentes. Isso permite realizar a troca sem interrupção da integração.

1. O cliente gera um novo token na Suite OnBlox.
2. O token é entregue ao parceiro por canal seguro.
3. O parceiro atualiza sua configuração.
4. O funcionamento da nova credencial é validado.
5. O cliente revoga o token antigo.

## 12. Checklist de homologação

Marque os itens para acompanhar o preparo da integração. O progresso fica salvo somente nesta aba do navegador.

- [ ]  Token gerado na Suite OnBlox do cliente.
- [ ]  Permissão mínima necessária configurada.
- [ ]  Token entregue por canal seguro.
- [ ]  Token armazenado em variável de ambiente ou cofre.
- [ ]  URL e token configurados individualmente por cliente.
- [ ]  Todas as chamadas utilizam HTTPS.
- [ ]  Todas as chamadas enviam X-API-Token.
- [ ]  Token não aparece em logs ou mensagens de erro.
- [ ]  Erros 401/403 não possuem retry automático.
- [ ]  Responsável pela rotação da credencial definido.
- [ ]  Tokens com validade têm troca planejada antes do vencimento.

## 13. Suporte

Ao abrir um chamado relacionado à API, informe:

**Contexto:** Cliente e URL base, sem informações sensíveis.

**Requisição:** Endpoint, método HTTP, data e horário da chamada.

**Retorno:** Status HTTP e campo message retornado pela API.

> **Nunca envie o API Token:** Não envie o token em chamados, e-mails ou mensagens.

Contato OnBlox: contato@onblox.com.br

## 14. Histórico de revisões

<table id="bkmrk-vers%C3%A3o-data-altera%C3%A7%C3%A3"><thead><tr><th>Versão</th><th>Data</th><th>Alteração</th></tr></thead><tbody><tr><td>1.0</td><td>06/10/2026</td><td>Primeira versão publicada para parceiros e sistemas integradores.</td></tr></tbody></table>

# Tutoriais



# Como Criar um Ticket na Plataforma de Suporte?

## EM EDIÇÃO

## Descrição

Criar um ticket de suporte irá trazer suas necessidades direto para a nossa equipe. O ticket será analisado pelos nossos especialista, podendo ser aprovado ou reprovado.

<p class="callout info">**Dica**: Quanto mais detalhes e informações forem informados, mais ágil será o andamento do ticket!</p>

---

## Pré-Requisitos

Para criar um ticket de suporte, é necessário:

- Um email cadastrado na plataforma de suporte onblox.

---

## Passo a Passo

Criar uma lista enumerada com os passos que o usuário deve fazer para alcançar o objetivo da operação. Se possível, inserir imagens, gifs e anotações que auxiliem o usuário a completar o passo.

1. Acesse o link do [**Portal Oficial**](https://onblox.atlassian.net/servicedesk/customer/portals "Portal Oficial").
2. Caso ainda não esteja logado, faça o login preenchendo os dados em tela.  
      
    [![Tela_Portal_Oficial.jpeg](https://docs.onblox.app.br/uploads/images/gallery/2024-11/scaled-1680-/whatsapp-image-2024-11-05-at-09-09-12.jpeg)](https://docs.onblox.app.br/uploads/images/gallery/2024-11/whatsapp-image-2024-11-05-at-09-09-12.jpeg)
3. Após o login, escolha a categoria do ticket que deseje criar.  
      
    [![Escolher_Ticket.jpeg](https://docs.onblox.app.br/uploads/images/gallery/2024-11/scaled-1680-/escolher-ticket.jpeg)](https://docs.onblox.app.br/uploads/images/gallery/2024-11/escolher-ticket.jpeg)
4. EDIÇÃO

---

## Observações

#### Usuário Sem Permissão

Se após fazer o login, retornar a mensagem **Sem Acesso**, entre em contato com a nossa equipe via [**WhatsApp**](https://wa.me/+556237029424 "WhatsApp") para fazer a liberação.

[![Sem_Acesso.jpeg](https://docs.onblox.app.br/uploads/images/gallery/2024-11/scaled-1680-/sem-acesso.jpeg)](https://docs.onblox.app.br/uploads/images/gallery/2024-11/sem-acesso.jpeg)

---

---