> For the complete documentation index, see [llms.txt](https://kb.stoque.com.br/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://kb.stoque.com.br/zeevdocs/integracoes/como-integrar-outras-ferramentas-com-o-zeev-docs/como-carregar-uma-interface-do-zeev-docs-em-outras-ferramentas-via-api/como-carregar-a-interface-de-digitalizacao-de-documentos-via-api.md).

# Como carregar a interface de digitalização de documentos via API

## Visão geral

Confira abaixo o modelo de estrutura XML para a Digitalização de documentos:

| Estrutura do XML                                                                                                                     | Requerido                      | Descrição                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| \<?xml version="1.0" encoding="UTF-8"?>                                                                                              | Sim                            | -                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| \<eContent>                                                                                                                          | Sim                            | Raiz.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| \<header>                                                                                                                            | Sim                            | Cabeçalho de identificação pelo Zeev docs.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| \<module name="smlwebscannew" />                                                                                                     | <p><br>Sim</p>                 | <p>Informações do módulo de entrada.<br>Atributo(s):<br><em>name</em> (obrigatório) - nome do módulo.</p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| \<application code=" " />                                                                                                            | <p><br>Sim</p>                 | <p>Identificação da aplicação.<br>Atributo(s):<br><em>code</em> (obrigatório) - código da aplicação.</p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| \<userToken />                                                                                                                       | Sim                            | Token de identificação do usuário para SilentLogin. Disponibilizada interface para geração do token através de web service.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| <p><br>      \<access limit=" " expireDate=" " /></p>                                                                                | <p><br><br>Sim</p>             | <p>Validade do acesso, podendo ser pela quantidade de acessos e pela data de expiração, valendo o que ocorrer primeiro.<br>Atributo(s):<br><em>limit</em> (obrigatório) - quantidade de execuções do token.<br><em>expireDate</em> (opcional) - data de validade do token.</p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| \<identification />                                                                                                                  | Não                            | Nó de livre preenchimento, podendo ser utilizado para inclusão de identificação do sistema que gerou o XML de SilentLogin.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| \<adHocUser />                                                                                                                       | Não                            | Usuário que será gravado o log de acesso e ação.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| \</ header>                                                                                                                          | -                              | -                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| \<structure>                                                                                                                         | -                              | -                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| \<events>                                                                                                                            | Não                            | Estrutura contendo configurações sobre os módulos que serão acessados.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| \<event name="smlwebscannew">                                                                                                        | <p><br>Sim</p>                 | <p>Informações do módulo de entrada.<br>Atributo(s):<br><em>name</em> (obrigatório) - nome do módulo.</p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| <p><br><br>            \<option showHeader=" " showFloatMenu=" " openHeader=" " openFloat=" " fullscreen=" " viewerTarget=" " /></p> | <p><br><br><br><br>Não</p>     | <p>Dentro de <em>"option"</em> é feita a configuração da exibição da interface do módulo.<br>Atributo(s):<br><em>showHeader</em> (opcional) - exibir o cabeçalho da página - true/false<br><em>showFloatMenu</em> (opcional) - exibir o painel (menu) lateral esquerdo - true/false.<br><em>openHeader</em> (opcional) - manter o painel superior da página visível - true/false.<br><em>openFloat</em> (opcional) - manter o painel (menu) lateral esquerdo visível - true/false.<br><em>fullscreen</em> (opcional) - forçar a abertura da janela ocupando toda a tela - true/false.<br><em>viewerTarget</em> (opcional) - nome do frame. Possibilita configurar o frame em que os documentos abertos para visualização ou edição devem ser carregados.<br>Ex: \_blank.</p>                                                                                                                                                                                                                      |
| \<content type=" ">                                                                                                                  | <p><br>Sim</p>                 | <p>Identificação do conteúdo onde serão aplicadas as parametrizações.<br>Atributo(s):<br><em>type</em> (obrigatório) - 'basic'.</p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| \<fields>                                                                                                                            | -                              | -                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| <p><br><br><br>                     \<field name=" " visible=" " enabled=" " required=" " defaultValue=" " commandOrName=" " /></p>  | <p><br><br><br><br><br>Não</p> | <p>Identificação do campo da aplicação.<br>Atributo(s):<br><em>name</em> (obrigatório) - nome do campo atribuído à aplicação.<br><em>visible</em> (opcional) - visibilidade do campo - true/false.<br><em>enabled</em> (opcional) - campo habilitado para edição - true/false.<br><em>required</em> (opcional) - preenchimento obrigatório - true/false.<br><em>defaultValue</em> (opcional) - texto ou valor padrão atribuído ao campo<br><em>commandOrName</em> (opcional) - Esse atributo só é válido para os campos de sistema DOCTYPE\_ID, IDXQUEUE\_ID, IDXSITDOC\_ID e PNDRSN\_ID. Ao utilizar o DOCTYPE\_ID, o atributo commandOrName deve ser preenchido com o mesmo valor do campo "Comando" do tipo de documento que deseja realizar a busca. Para os demais, o atributo commandOrName deve ser preenchido com o mesmo valor do campo "Nome" da fila, situação e/ou pendência. <strong>Caso seja informado o defaultValue, o atributo commandOrName não será considerado.</strong></p> |
| \</ fields>                                                                                                                          | -                              | -                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| \</ content>                                                                                                                         | -                              | -                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| \</ event>                                                                                                                           | -                              | -                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| \</ events>                                                                                                                          | -                              | -                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| \</structure>                                                                                                                        | -                              | -                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| \</eContent >                                                                                                                        | -                              | -                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |

Efetue o download do modelo de XML:

{% file src="/files/uxPEObxzmjXuihS7JEeB" %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://kb.stoque.com.br/zeevdocs/integracoes/como-integrar-outras-ferramentas-com-o-zeev-docs/como-carregar-uma-interface-do-zeev-docs-em-outras-ferramentas-via-api/como-carregar-a-interface-de-digitalizacao-de-documentos-via-api.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.