---
title: "Guia de Integração - Scanner Service"
description: "Integração ao Lacuna Scanner Service: a digitalização ocorre em uma página do serviço, que cuida dos scanners e dos metadados do Decreto 10.278/2020."
canonical: "https://docs.lacunasoftware.com/articles/scanner/integration"
locale: "pt-BR"
product: "Scanner"
last_updated: "2026-07-14"
---

# Guia de Integração - Scanner Service

O [Lacuna Scanner Service](https://docs.lacunasoftware.com/articles/scanner) lhe permite adicionar uma página de digitalização à sua aplicação web existente de maneira rápida e fácil porque
a digitalização em si ocorre em uma página do serviço, e não da sua aplicação, liberando esta de lidar com as complexidades envolvidas na
comunicação com scanners e no preenchimento dos metadados obrigatórios previstos no [Decreto Nº 10.278/2020](http://www.planalto.gov.br/ccivil_03/_Ato2019-2022/2020/Decreto/D10278.htm).

## Exemplo

Por exemplo, suponha que na sua aplicação exista um formulário que aceita *upload* de arquivos e você queira adicionar um botão para digitalização:

![Demo step 1](https://docs.lacunasoftware.com/images/scanner/demo-1.png)

Ao clicar no botão, o usuário é redirecionado para a página de digitalização:

![Demo step 2](https://docs.lacunasoftware.com/images/scanner/demo-2.png)

> **Observação**
>
> A página de digitalização pode ser personalizada com a logomarca e cores da sua aplicação de modo a oferecer ao usuário uma experiência
> homogênea (a imagem acima é um exemplo de personalização).

Ao concluir o processo de digitalização, o usuário é redirecionado de volta à sua aplicação:

![Demo step 3](https://docs.lacunasoftware.com/images/scanner/demo-3.png)

A sua aplicação então faz uma chamada à API do serviço para obter o documento digitalizado:

![Demo step 4](https://docs.lacunasoftware.com/images/scanner/demo-4.png)

## Visão geral

O procedimento se inicia com a sua aplicação criando uma **sessão de digitalização**, passando o **returnUrl** – a URL à qual o usuário deve ser
levado de volta ao final do processo. A sua aplicação recebe de volta o **redirectUrl** – a URL à qual o usuário deve ser levado para iniciar o
processo de digitalização:

![Integration part 1](https://docs.lacunasoftware.com/images/scanner/integration-1.png)

Ao final do processo de digitalização, o usuário é levado de volta à sua aplicação (na URL **returnUrl**). É adicionado à URL um argumento chamado **scanSessionId**.
Com esse argumento, a sua aplicação faz uma chamada à API do serviço para obter o(s) documento(s) digitalizado(s):

![Integration part 2](https://docs.lacunasoftware.com/images/scanner/integration-2.png)

## Parâmetros de comunicação

Você precisará dos seguintes parâmetros:

* **Endpoint**: endereço do Scanner Service, ex: `https://scn.lacunasoftware.com/`
* **API Key**: chave de acesso à API

Solicite ao nosso [suporte ao desenvolvedor](mailto:suporte@lacunasoftware.com) seus parâmetros.

## Linguagens de programação

Escolha uma linguagem de programação para instruções específicas:

* [.NET](https://docs.lacunasoftware.com/articles/scanner/integration/dotnet)
* [PHP](https://docs.lacunasoftware.com/articles/scanner/integration/php)
* Para outras linguagens: [Integração por REST API](https://docs.lacunasoftware.com/articles/scanner/integration/other)