Manual de Integração

(1)

Manual de Integração

Versão 1.15

(2)

Versão 1.15 –

Copyright Integral Sistemas

13/11/2020

Pág. 2

Sumário

1. Introdução ...3

2. Padrão de comunicação ...4

3. Padrão das Mensagens XML ...5

3.1 Validação da estrutura das mensagens XML ...5

4. Estrutura de Dados do Web Services...7

4.1 Modelo Operacional ...7

4.2 Serviços ...8

4.2.1 Publicação de Documento ...9

4.2.2 Publicação de Documento Assinado ...12

4.2.3 Verificação do Status de Documentos ...14

4.2.4 Finalizar Processo de Assinatura ...15

4.2.5 Recuperação de Documento ...16

4.2.6 Recuperação de Protocolo ...17

4.2.7 Cancelamento de um Processo de Assinatura ...18

4.2.8 Contas do Publicador ...19

4.2.9 Atualizar Processo de Assinatura ...20

4.2.10 Atualizar Cadastro de Usuário ...21

4.3 Exemplo mensagem padrão SOAP 1.2 de envio ...22

4.4 Exemplo mensagem padrão SOAP 1.2 de retorno ...22

4.5 Exemplo de conteúdo do arquivo XML de envio ...23

(3)

1. Introdução

Esse documento descreve os meios para a integração de sistemas clientes com Portal de

Assinaturas AssinaWeb via WebServices, padrão SOAP.

O AssinaWeb provê um mecanismo de comunicação onde é possível publicar lotes de documentos

para que sejam disponibilizados para assinaturas dos signatários.

Todo fluxo envolvido no processo de coleta de assinaturas é controlado pelo AssinaWeb, desde a

publicação do documento até o encerramento.

Os aplicativos que consomem o WebService poderão ser desenvolvidos em qualquer linguagem,

desde que a mesma suporte o padrão proposto (SOAP).

(4)

Versão 1.15 –

13/11/2020

Pág. 4

2. Padrão de comunicação

O modelo de comunicação segue o padrão de Web Services definido pelo WS-IBasic Profile. A troca

de mensagens entre o Web Service será realizada no padrão SOAP, com troca de mensagens XML

no padrão Style/Enconding: Document/Literal, wrapped. O WSDL é o padrão recomendado para

descrição de serviços SOAP.

As chamadas aos serviços serão feitas enviando como parâmetro um documento XML a ser

processado pelo sistema. Esse documento não fará parte da descrição do serviço (arquivo WSDL),

e o formato do XML correspondente ao serviço deverá ser consultada nesse manual de integração,

seção 4.2.

(5)

3. Padrão das Mensagens XML

A especificação adotada para as mensagens XML é a recomendação W3C para XML 1.0, disponível

em HTTP://www.w3.org/TR/REC-xml e a codificação dos caracteres será em UTF-8.

As chamadas dos Web Services disponibilizados pelo AssinaWeb e os respectivos resultados do

processamento são realizadas através das mensagens com o seguinte padrão:

Área de Cabeçalho – estrutura XML padrão para todas as mensagens de chamada e retorno

de resultado dos Web Services disponibilizados. A área de cabeçalho está sendo utilizada

para armazenar a versão do leiaute da estrutura XML informada na área de dados.

Área de Dados – estrutura XML variável definida na documentação do Web Service

acessado.

O campo <VersaoDados> deve conter a informação da versão do leiaute da estrutura XML

armazenada na área de dados da mensagem. A estrutura XML armazenada na área de dados está

definida na documentação do Web Service acessado.

3.1 Validação da estrutura das mensagens XML

As informações são enviadas ou recebidas do Web Services através de mensagens no padrão XML

definido na documentação de cada serviço.

As alterações de leiaute e da estrutura de dados XML realizadas nas mensagens são controladas

através da atribuição de um número de versão para a mensagem.

Um Schema XML é uma linguagem que define o conteúdo do documento XML, descrevendo os seus

elementos e a sua organização, além de estabelecer regras de preenchimento de conteúdo e de

obrigatoriedade de cada elemento ou grupo de informação. A validação da estrutura XML da

mensagem é realizada por um analisador sintático (parser) que verifica se a mensagem atende as

definições e regras de seu Schema XML. Qualquer divergência da estrutura XML da mensagem em

relação ao seu Schema XML provoca um erro de validação do Schema XML.

Id Campo Descrição El. Pai Tp Ocor. Tam.

A01

AssinaWeb

TAG Raiz do arquivo XML Rai

z

A02

VersaoDados

Versão do layout. Informar ‘1.00’. A A01 N 1-1 4,2 A03

TpAmbiente

Tipo de ambiente. H = Homologação / P =

Produção

E A01 C 1-1 1 A04

IdChaveAcesso

Identificador da chave de acesso para acessar

o serviço

(6)

Versão 1.15 –

13/11/2020

Pág. 6

A primeira condição para que a mensagem seja validada com sucesso é que ela seja submetida ao

Schema XML correto.

Assim, os aplicativos clientes devem estar preparados para gerar as mensagens no leiaute em vigor,

devendo ainda informar a versão do leiaute da estrutura XML da mensagem no campo

<VersaoDados> da área de cabeçalho da mensagem.

(7)

4. Estrutura de Dados do Web Services

Existirá um único Web Service com todos os serviços apresentados no item 4.2. O fluxo de

comunicação é sempre iniciado pelo sistema cliente através do envio de uma mensagem XML para

o serviço desejado.

4.1 Modelo Operacional

Os Web Services do AssinaWeb são do tipo síncrono, ou seja, o processamento da solicitação de

serviço é sempre concluído na mesma conexão, com a devolução de uma mensagem com o

resultado do processamento do serviço solicitado.

O diagrama abaixo ilustra o fluxo conceitual de comunicação entre o aplicativo cliente e os serviços

do AssinaWeb:

Sistema Cliente

AssinaWeb

Web Service _{Processamento} <XML> Resultado

<XML> Requisição

Exemplo de operação do serviço de publicação de documento em um processo ideal:

1. O sistema cliente inicia a conexão enviando uma mensagem de solicitação de serviço

“PublicarDocumento”;

2. O Web Service recebe a mensagem de solicitação de serviço e encaminha ao AssinaWeb

que irá processar o serviço solicitado;

3. O AssinaWeb processa a requisição e devolve uma mensagem de resultado do

processamento;

4. O Web Service recebe a mensagem de resultado do processamento e encaminha ao

sistema cliente.

(8)

Versão 1.15 –

13/11/2020

Pág. 8

4.2 Serviços

O Web Service do AssinaWeb está disponível nos seguintes endereços e disponibilizam os

seguintes serviços:

Ambiente de Produção:

https://www2.assinaweb.com.br/webservices/publicacaodocumentos.asmx

Ambiente de Homologação:

https://homol.assinaweb.com.br/webservices/publicacaodocumentos.asmx

Serviços disponíveis:

Serviço

Método

Versão

Publicação de Documento PublicarDocumento 3.00

Publicação de Documento Assinado PublicarDocumentoAssinado 1.00 Verificação do Status de Documentos VerificarDocumento 1.00

Recuperação de Documento RecuperarDocumento 1.00

Recuperação de Protocolo RecuperarProtocolo 1.00

Cancelamento de Processo de Assinatura CancelarDocumento 1.00

Contas do Publicador ContasPublicador 1.00

Atualizar Processo de Assinatura AtualizarProcessoAssinatura 1.00 Finalizar Processo de Assinatura FinalizarDocumento 1.00 Atualizar Cadastro de Usuário AtualizarCadastroUsuario 1.00

(9)

4.2.1 Publicação de Documento

Serviço para a publicação de documento para o processo de assinatura digital e disponibilização

dos respectivos signatários do processo.

Leiaute de Entrada

Estrutura XML contendo informações do documento a ser publicado e seus signatários.

A01

AssinaWeb

TAG Raiz do arquivo XML Raiz

A02

VersaoDados

Versão do layout. Informar ‘3.00’. A A01 N 1-1 4,2 A03

TpAmbiente

Produção

E A01 C 1-1 1 A04

CpfCnpjPublicador

CPF (em caso de pessoa física – tam. 11 ) ou

CNPJ (em caso de pessoa jurídica – tam. 14) do publicador.

E A01 C 1-1 14

A05

ContaPublicacao

Identificador da conta do publicador onde o documento será associado. Se este atributo for omitido, o documento será publicado na conta padrão do publicador (Conta Individual).

E A01 C 0-1 15

A06

IdChaveAcesso

Identificador da chave de acesso para acessar o serviço

E A01 C 1-1 64 B01

documento

Informações do documento e signatários G A01 1-1

B02

DsDocumento

Título do documento a ser publicado E B01 C 1-1 255 B03

DsDetalhesDocumento

Informações detalhadas do documento E B01 C 1-1 2000 B04

DtLimiteAssinatura

Data limite para assinatura do documento.

Formato AAAA-MM-DD HH24:MI:SS. Exemplo : 2015-05-01 09:00:00

E B01 C 1-1 19

B05

InStatusDocumento

Indica se o documento será publicado habilitado para assinatura ou se o processo de assinatura do documento será interrompido temporariamente, ou seja, publicado porém pausado para assinaturas. Possíveis valores: ‘P’ – Pendente ou ‘I’- Interrompido. Se omitido o valor padrão será ‘P’. Não Implementado.

E B01 C 0-1 1

B06

InEmailEventos

Indicador de envio de eventos para as partes envolvidas a cada mudança de Status. Possíveis valores : ‘S’ ou ‘N’. Se for informado ‘S’, todas as partes receberão e-mails de notificação nas mudanças de status do documento.

E B01 C 1-1 1

B07

DsSenhaDocumento

Senha do documento PDF. Deixar o conteúdo do elemento ‘em branco’ para não bloquear o documento com senha.

E B01 C 1-1 255

B08

MD5Documento

MD5 do documento E B01 C 1-1 50

B09

DsCodigoVerificacao

Código gerado pelo cliente (app de terceiros) que consta na marca dágua e que será utilizado pelo Portal AssinaWeb na geração do protocolo de assinaturas.

E B01 C 1-1 255

B10

InMarcaDagua

Indicador de geração da marca d´água no documento. Possíveis valores : ‘S’, ‘N’ ou ‘P’. (P=incluir Marca D’água na publicação).

E B01 C 1-1 1

B11

Lin1MarcaDagua

Texto que será inserido na primeira linha da marca d’agua da lateral direita.

E B01 C 1-1 150 B12

Lin2MarcaDagua

Texto que será inserido na segunda linha da

marca d’agua da lateral direita.

E B01 C 1-1 150 B13

FontSizeMarcaDagua

Tamanho da fonte. Recomendado 8 a 14 E B01 C 1-1 2 B14

FontColorMarcaDagua

Cor da Fonte. Default:LIGHT_GRAY; 1-GRAY;

2-DARK_GRAY; 3-BLACK

E B01 C 1-1 1 B15

DeslocamentoMarcaDa

gua

Parâmetro que permite o deslocamento das linhas da marca dágua. Valores permitidos: 11 <= valor <= 30. Se omitido o valor padrão será 20p.

(10)

Versão 1.15 –

13/11/2020

Pág. 10

B16

RodapeMarcaDagua

Texto que será inserido no rodapé do

documento, ou indicador de geração da marca d´água no rodapé do documento. Valores : ‘0’ sem rodapé, ‘1’ participantes, ‘2’ participante e data de assinatura (unilateral) ou ‘3’. Marca d’água padrão.

E B01 C 0-1 150

B17

LateralMarcaDagua

Indicador de marca d’água na lateral direita do documento. 0-Sem marca d’água, 1-Padrão, 2-Padronizada pelo usuário ou 3-Específico do cliente.

B01 N 0-1 1

B18

InPrecedenciaEtapas

(Fluxo Assinaturas). Indicador de

precedência entre as etapas do processo de assinatura. Possíveis valores : ‘S’ ou ‘N’. Se informado ‘S’, os parâmetros de fluxo de assinaturas são exigidos no grupo de participantes.

E B01 N 0-1 1

C01 GRUPO de Participantes do processo G B01 1-1

D01

participantes

GRUPO de Participantes do processo G B01 1-1 D02

participante

Informações do participante G C01 1-100 D03

CpfCnpj

CNPJ (em caso de pessoa jurídica – tam. 14) do participante.

E D01 C 1-1 14

D04

DsNome

Nome do Signatário E D01 C 1-1 128

D05

DsEmail

Email do participante E D01 C 1-1 128

D06

DsTelefoneContato

Telefone do participante E D01 C 1-1 20 D07

DsLogradouro

Endereço do participante E D01 C 0-1 50 D08

DsNumeroEndereco

Número do endereço E D01 C 0-1 50 D09

DsComplemento

Complemento de endereço E D01 C 0-1 50

D10

DsBairro

Bairro E D01 C 0-1 50

D11

DsCep

CEP E D01 C 0-1 9

D12

DsUf

UF do endereço E D01 C 0-1 2

D13

DsIdentidade

RG do participante E D01 C 0-1 50

D14

DsCidade

Cidade E D01 C 0-1 50

D15

TpAssinatura

Tipo de assinatura habilitado para o participante. Valores permitidos: “ELETRO”-eletrônica; “ICP”-ICP-Brasil; ”MANUSCRITO” Se omitido o valor padrão será “ICP”.

E D01 C 0-1 10

D16

Perfil

Perfil do participante no processo. Valores permitidos: “S”-signatário; “A”-autorizador; “O”-observador. Este campo é obrigatório.

E D01 C 1-1 1

D17

DsIdioma

Identifica o idioma do participante. Formato ISO 639-1 de padrões internacionais para códigos linguísticos. (https://en.wikipedia.org/wiki/ISO_639-1(https://en.wikipedia.org/wiki/ISO_639-1)

E D001 C 0-1 10

D18

DsAliasPerfil

Descrição de um alias para o perfil. E D01 C 0-1 128 D19

NrEtapa

(Fluxo assinaturas). Identifica o número da

etapa do fluxo de assinaturas. Valor numérico de 0 a 3.

E D01 N 0-1 1

D20

InPrecedenciaPartic

ipantes

(Fluxo assinaturas). Indicador de precedência entres os participantes da etapa. Possíveis valores : ‘S’ ou ‘N’.

E D01 C 0-1 1

D21

NrAssinaturasEtapa

(Fluxo assinaturas). Indicador de atuações de participantes necessárias para finalizar uma etapa. Caso seja etapa única ou a última etapa, o processo de assinatura será finalizado. Valor numérico de 1 até o número de participantes da etapa.

(11)

Leiaute de Saída

Estrutura XML contendo informações referentes ao processamento da solicitação:

Regras de Negócio e Mensagens de Retorno

Regra de

Negócio

Mensagem

Código de

retorno

- Documento publicado com sucesso 0

RN001 Saldo insuficiente para publicação do(s) documento(s) 1 RN002 Usuário com o CPF/CNPJ informado não tem conta no sistema 8

RN003 O publicador não está associado a esta conta 9

RN004 O publicador não tem permissão de publicação nesta conta 10 RN005 Existe um documento publicado com o mesmo código de verificação 11

A01

AssinaWeb

z

A02

VersaoDados

Versão do layout. A A01 N 1-1 4,2

B01

publicacao

Informações da publicação G A01 1-1

B02

idDocumento

Código de verificação do documento. É apresentado em caso de publicação realizada com sucesso.

E B01 C 0-1 255

C01

participantes

GRUPO de Participantes do processo G B01 1-1 D01

participante

CpfCnpj

CNPJ (em caso de pessoa jurídica – tam. 14) do participante.

E D01 C 1-1 14

D04

Token

Token de autenticação paras as políticas S0 e S1.

E D01 C 1-1 512 B03

retorno

Código de retorno do processamento e regras

de negócio.

E B01 C 1-1 4 B04

mensagem

Mensagem de retorno do processamento e

regras de negócio.

(12)

Versão 1.15 –

13/11/2020

Pág. 12

4.2.2 Publicação de Documento Assinado

Serviço para a publicação de documento já assinado por aplicativos de terceiros (standalone) para

armazenamento na nuvem e posterior visualização.

Leiaute de Entrada

Estrutura XML contendo informações do documento a ser publicado e os dados de assinatura.

A01

AssinaWeb

A02

VersaoDados

TpAmbiente

Produção

E A01 C 1-1 1 A04

CpfCnpjPublicador

E A01 C 1-1 14

A05

ContaPublicacao

Identificador da conta do publicador onde o documento será associado. Se este atributo for omitido, o documento será publicado na conta padrão do publicador (Conta Individual)

E A01 C 0-1 15

A06

IdChaveAcesso

E A01 C 1-1 64 B01

documento

B02

DsDocumento

Título do documento a ser publicado E B01 C 1-1 255 B03

DsDetalhesDocumento

Informações detalhadas do documento E B01 C 1-1 2000 B04

DtLimiteAssinatura

Data limite para assinatura do documento.

Formato AAAA-MM-DD HH24:MI:SS. Exemplo : 2015-05-01 09:00:00

E B01 C 1-1 19

B05

MD5Documento

B06

DsCodigoVerificacao

Código gerado pelo cliente (app de terceiros) que consta na marca dágua e que será utilizado pelo Portal AssinaWeb na geração do protocolo de assinaturas.

E B01 C 1-1 255

C01

participantes

GRUPO de participantes G B01 1-1 D01

participante

Informações do participante com perfil

Signatário (* Apenas para Signatário)

G C01 1-100 D02

CpfCnpj

CNPJ (em caso de pessoa jurídica – tam. 14) do signatário.

E D01 C 1-1 14

D03

DsNome

Nome do Signatário E D01 C 1-1 128

D04

DsEmail

E-mail do Signatário E D01 C 1-1 128

D05

DsTelefoneContato

Telefone de contato do Signatário E D01 C 1-1 20 D06

DtAssinatura

Data em que o signatário assinou o

documento. Formato AAAA-MM-DD HH24:MI:SS. Exemplo : 2015-05-01 09:00:00

E D01 C 1-1 19

D07

DtVisualizacao

Data em que o signatário visualizou o documento. Formato AAAA-MM-DD HH24:MI:SS. Exemplo : 2015-05-01 09:00:00. Não é obrigatório.

(13)

Leiaute de Saída

Estrutura XML contendo informações referentes ao processamento da solicitação:

Regras de Negócio e Mensagens de Retorno

Regra de

Negócio

Mensagem

Código de

retorno

RN004 O publicador não tem permissão de publicação nesta conta 10

A01

AssinaWeb

A02

VersaoDados

Versão do layout. A A0

1

N 1-1 4,2

B01

publicacao

Informações da publicação G A0

1

1-1 B02

idDocumento

Código de verificação do documento. É

apresentado em caso de publicação realizada com sucesso.

E B01 C 0-1 255

B03

retorno

Código de retorno do processamento e regras de negócio.

E B01 C 1-1 4 B04

mensagem

regras de negócio.

(14)

Versão 1.15 –

13/11/2020

Pág. 14

4.2.3 Verificação do Status de Documentos

Serviço que permite acompanhar o status dos documentos publicados.

Leiaute de Entrada

Estrutura XML contendo o identificador dos documentos que serão consultados.

A01

AssinaWeb

A02

VersaoDados

TpAmbiente

Produção

E A01 C 1-1 1 A04

IdChaveAcesso

o serviço

E A01 C 1-1 64

B01

documento

Informações do documento G A01 1-n

B02

IdDocumento

Identificador do documento E B01 C 1-1 255

Leiaute de Saída

Estrutura XML contendo informações referentes ao processamento da solicitação:

Regras de Negócio e Mensagens de Retorno

Regra de

Negócio

Descrição

Código de

retorno

- Documento verificado com sucesso 0

- Documento não encontrado 1

RN005 Se o tag <statusDoc> = 'F' e pelo menos um dos signatários retornados pelo serviço não realizou a sua assinatura, ou seja, possui a tag <dtAssinatura> vazia, significa que o processo foi finalizado por "Data limite de assinatura".

2

A01

AssinaWeb

A02

VersaoDados

B01

documento

B02

retorno

E B01 C 0-1 4 B03

mensagem

regras de negócio.

E B01 C 1-1 1-n B04

idDocumento

regras de negócio.

E B01 C 1-1 255 B05

statusDoc

Status do documento consultado. Valores

possíveis: ‘P’ – Pendente de assinaturas, ‘F’ – Finalizado, ‘I’ – Coleta de assinaturas interrompido e ‘C’ – Processo cancelado.

E B01 C 1-1 1

C01

signatarios

GRUPO de signatários G B01 1-1

D01

signatario

Informações do signatário G C01 1-100 D02

CPF

CNPJ (em caso de pessoa jurídica – tam. 14) do signatário

E D01 C 1-1 14)

D03

Nome

Nome do signatário E D01 C 1-1 128

D04

dtAssinatura

Data que o signatário assinou o documento. Formato AAAA-MM-DD HH24:MI:SS. Exemplo : 2015-05-01 09:00:00

E D01 C 1-1 19

D05

justificativa

Justificativa da recusa do processo de assinatura.

(15)

4.2.4 Finalizar Processo de Assinatura

Serviço que permite finalizar processo de assinatura.

Leiaute de Entrada

Estrutura XML contendo o identificador dos documentos que serão finalizados.

A01

AssinaWeb

TAG Raiz do arquivo XML Ra

iz

A02

VersaoDados

TpAmbiente

Produção

E A01 C 1-1 1 A04

IdChaveAcesso

o serviço

E A01 C 1-1 64

B01

documento

B02

IdDocumento

Identificador do documento E B01 C 1-1 255

Leiaute de Saída

Estrutura XML contendo informações referentes ao processamento da solicitação:

Regras de Negócio e Mensagens de Retorno

Regra de

Negócio

Descrição

Código de

retorno

- Documento finalizado com sucesso 0

- Documento já finalizado 2

A01

AssinaWeb

A02

VersaoDados

B01

documento

B02

retorno

E B01 C 0-1 4 B03

mensagem

Mensagem de retorno do processamento

e regras de negócio.

E B01 C 1-1 1-n B04

idDocumento

Mensagem de retorno do processamento

e regras de negócio.

E B01 C 1-1 255 B05

statusDoc

Status do documento consultado. Valores

possíveis: ‘P’ – Pendente de assinaturas, ‘F’ – Finalizado, ‘I’ – Coleta de assinaturas interrompido e ‘C’ – Processo cancelado.

E B01 C 1-1 1

C01

signatarios

GRUPO de signatários G B01 1-1

D01

signatario

Informações do signatário G C01 1-100 D02

CPF

CPF (em caso de pessoa física – tam. 11 )

ou CNPJ (em caso de pessoa jurídica – tam. 14) do signatário

E D01 C 1-1 14

D03

Nome

Nome do signatário E D01 C 1-1 128

D04

inStatusAssinatura

Status da situação do documento por participante. Valores possíveis: ‘P’ – Pendente de assinaturas, ‘A’ – Assinado, ‘R’ – Recusado e ‘N’ – Não atuou no documento.

E D01 C 1-1 1

D05

dtAssinatura

Data que o signatário atuou no documento. Formato AAAA-MM-DD HH24:MI:SS. Exemplo : 2015-05-01 09:00:00

E D01 C 1-1 19

D06

justificativa

Justificativa da recusa do processo de assinatura.

(16)

Versão 1.15 –

13/11/2020

Pág. 16

4.2.5 Recuperação de Documento

Serviço que permite realizar o download do documento em base64.

Leiaute de Entrada

Este serviço não possui um leiaute de XML na requisição. Para recuperar o documento informe o

identificador do documento como string:

<IdDocumento>ID do documento como string</IdDocumento>

Leiaute de Saída

Estrutura XML contendo informações referentes ao processamento da solicitação:

Regras de Negócio e Mensagens de Retorno

Regra de

Negócio

Descrição

Código de

retorno

- Documento recuperado com sucesso 0

- ID do documento inválido 1

(17)

4.2.6 Recuperação de Protocolo

Serviço que permite realizar o download do protocolo em base64.

Leiaute de Entrada

Este serviço não possui um leiaute de XML na requisição. Para recuperar o protocolo informe o

identificador do documento como string:

<IdDocumento>ID do documento como string</IdDocumento>

Leiaute de Saída

Estrutura XML contendo informações referentes ao processamento da solicitação:

Regras de Negócio e Mensagens de Retorno

Regra de

Negócio

Descrição

Código de

retorno

- Protocolo recuperado com sucesso 0

- ID do documento inválido 1

- Processo não está finalizado 2

- Não foi possível recuperar o protocolo 3

- Erro na geração do PDF do protocolo 4

A01

AssinaWeb

z

A02

VersaoDados

B01

documento

Informações do documento G A01 1-1

B02

retorno

E B01 C 1-1 4 B03

mensagem

regras de negócio.

E B01 C 1-1 1-n B04

idDocumento

regras de negócio.

E B01 C 1-1 255 B05

docBase64

Protocolo em base 64 string E B01 C 1-1 1-n

(18)

Versão 1.15 –

13/11/2020

Pág. 18

4.2.7 Cancelamento de um Processo de Assinatura

Serviço que permite cancelar um processo de assinatura de documento em curso.

Leiaute de Entrada

Estrutura XML contendo o identificador dos documentos que serão cancelados.

A01

AssinaWeb

TAG Raiz do arquivo XML Ra

iz

A02

VersaoDados

TpAmbiente

Produção

E A01 C 1-1 1 A04

CpfCnpjPublicador

E A01 C 1-1 14

A05

IdChaveAcesso

E A01 C 1-1 64

B01

documento

B02

IdDocumento

Identificador do documento que será cancelado.

E B01 C 1-1 255

Leiaute de Saída

Estrutura XML contendo informações referentes ao processamento da solicitação:

Regras de Negócio e Mensagens de Retorno

Regra de

Negócio

Descrição

Código de

retorno

- Documento cancelado com sucesso 0

RN006 Publicador informado não pode cancelar este processo 2

A01

AssinaWeb

z

A02

VersaoDados

B01

documento

B02

idDocumento

Mensagem de retorno do processamento e regras de negócio.

E B01 C 1-1 255 B03

retorno

de negócio.

E B01 C 0-1 4 B04

mensagem

regras de negócio.

(19)

4.2.8 Contas do Publicador

Serviço que permite consultar as contas que o publicador tem permissão de publicação de

documentos no sistema.

Leiaute de Entrada

Este serviço não possui um leiaute de XML na requisição. Para consultar as contas, informe o

CPF/CNPJ do publicador como string:

<CpfCnpj> CPF/CNPJ do publicador como string</ CpfCnpj>

Leiaute de Saída

Estrutura XML contendo informações referentes ao processamento da solicitação:

Regras de Negócio e Mensagens de Retorno

Regra de

Negócio

Descrição

Código de

retorno

- Consulta realizada com sucesso 0

- CPF/CNPJ do publicador inválido -1

A01

AssinaWeb

z

A02

VersaoDados

B01

contasPublicador

Informações das contas do Publicador G A01 1-1 B02

retorno

de negócio.

E B01 C 1-1 4 B03

mensagem

regras de negócio.

E B01 C 1-1 1-n B04

idDocumento

regras de negócio.

E B01 C 1-1 255

C01

contas

GRUPO de contas G B01 1-1

D01

conta

Informações da conta G C01 1-n

D02

id

Identificador da conta E D01 E 1-1 15

D03

nomeConta

Nome da conta E D01 E 1-1 128

D04

tipoConta

Tipo da conta (“Conta Individual” ou “Conta Corporativa de UN”)

E D01 E 1-1 128 D05

unidadeNegocio

Descrição da unidade de negócio associada.

Será apresentado somente no caso de conta corporativa.

(20)

Versão 1.15 –

13/11/2020

Pág. 20

4.2.9 Atualizar Processo de Assinatura

Serviço para a atualização do processo de assinatura digital. Esse serviço atualiza o status do

documento e o documento (PDF) e o status dos participantes.

Leiaute de Entrada

Estrutura XML contendo informações do documento a ser publicado e seus signatários.

Leiaute de Saída

Estrutura XML contendo informações referentes ao processamento da solicitação:

Regras de Negócio e Mensagens de Retorno

Regra de

Negócio

Mensagem

Código de

retorno

RN004 O publicador não tem permissão de publicação nesta conta 10

A01

AssinaWeb

z

A02

VersaoDados

TpAmbiente

Produção

E A01 C 1-1 1 A04

IdChaveAcesso

Identificador da chave de acesso para

acessar o serviço

E A01 C 1-1 64 B01

documento

B02

MD5Documento

B03

DsCodigoVerificacao

Código de identificação do documento. E B01 C 1-1 36 D01

participantes

GRUPO de Participantes do processo G B01 1-1

D02

participante

CpfCnpj

CNPJ (em caso de pessoa jurídica – tam. 14) ) do participante.

E D01 C 1-1 14

D04

DtAssinatura

Data da assinatura do documento E D01 D 1-1 20

Perfil

Perfil do participante no processo. Valores permitidos: “S”-signatário; “A”-autorizador; “O”-observador. Este campo é obrigatório.

E D01 C 1-1 1

A01

AssinaWeb

z

A02

VersaoDados

B01

atualização

Informações da atualização G A01 1-1 B02

idDocumento

Código de verificação do documento. É

apresentado em caso de publicação realizada com sucesso.

E B01 C 0-1 255

B03

retorno

E B01 C 1-1 4 B04

mensagem

regras de negócio.

(21)

4.2.10 Atualizar Cadastro de Usuário

Serviço para a atualização do cadastro de usuário. Esse serviço atualiza o nome, e-mail e telefone

do usuário.

Leiaute de Entrada

Estrutura XML contendo informações do documento a ser publicado e seus signatários.

Leiaute de Saída

Estrutura XML contendo informações referentes ao processamento da solicitação:

Regras de Negócio e Mensagens de Retorno

Regra de

Negócio

Mensagem

Código de

retorno

RN001 Usuário não cadastrado 1

RN002 Erro ao atualizar o cadastro do usuário 2

A01

AssinaWeb

z

A02

VersaoDados

TpAmbiente

Produção

E A01 C 1-1 1 A04

IdChaveAcesso

Identificador da chave de acesso para

acessar o serviço

E A01 C 1-1 64

B01

usuario

Informações do usuário G A01 1-1

B02

CdUsuario

CPF (em caso de pessoa física – tam. 11 ) ou CNPJ (em caso de pessoa jurídica – tam. 14) ) do usuário.

E B01 C 1-1 14

B03

DsNomeUsuario

Nome do usuário. E B01 C 1-1 128

B04

DsEmail

Email do usuário E D01 C 1-1 128

B05

DsTelefoneContato

Telefone de contato do usuário E D01 C 1-1 20

A01

AssinaWeb

z

A02

VersaoDados

B01

atualização

Informações da atualização G A01 1-1 B03

retorno

de negócio.

E B01 C 1-1 4 B04

mensagem

regras de negócio.

(22)

Versão 1.15 –

13/11/2020

Pág. 22

Exemplo de Operação do Serviço PublicarDocumento

4.3 Exemplo mensagem padrão SOAP 1.2 de envio

POST /webservices/publicacaodocumentos.asmx HTTP/1.1

Host: homol.assinaweb.com.br

Content-Type: application/soap+xml; charset=utf-8

Content-Length:

length

<?xml version="1.0" encoding="utf-8"?>

<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

xmlns:xsd="http://www.w3.org/2001/XMLSchema"

xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">

<soap12:Body>

<PublicarDocumento xmlns="http://tempuri.org/">

<XmlDocumento>

string

</XmlDocumento>

<pdfBase64>

string

</pdfBase64>

</PublicarDocumento>

</soap12:Body>

</soap12:Envelope>

4.4 Exemplo mensagem padrão SOAP 1.2 de retorno

HTTP/1.1 200 OK

Content-Type: application/soap+xml; charset=utf-8

Content-Length:

length

<?xml version="1.0" encoding="utf-8"?>

<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

xmlns:xsd="http://www.w3.org/2001/XMLSchema"

xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">

<soap12:Body>

<PublicarDocumentoResponse xmlns="http://tempuri.org/">

<PublicarDocumentoResult>

xml

</PublicarDocumentoResult>

</PublicarDocumentoResponse>

</soap12:Body>

</soap12:Envelope>

(23)

4.5 Exemplo de conteúdo do arquivo XML de envio

<?xml version="1.0" encoding="utf-8"?> <AssinaWeb VersaoDados="1.00"> <TpAmbiente>H</TpAmbiente> <CpfCnpjPublicador>11222333000110</CpfCnpjPublicador> <ContaPublicacao>12345</ContaPublicacao> <IdChaveAcesso>MuahIhRWM+dIvbT1veqJ58PoIaqxaf/NZdT45ao6NBk=</IdChaveAcesso> <documento>

<DsDocumento>Teste 1310E #1</DsDocumento>

<DsDetalhesDocumento><![CDATA[Teste carga AssinaWeb]]></DsDetalhesDocumento> <DtLimiteAssinatura>2016-12-12 18:41:16</DtLimiteAssinatura> <InStatusDocumento></InStatusDocumento > <InEmailEventos>S</InEmailEventos> <DsSenhaDocumento>123</DsSenhaDocumento> <MD5Documento>EB661078ECA1344EE2D17B462279CC4E</MD5Documento> <InMarcaDagua>S</InMarcaDagua> <participantes> <participante> <CpfCnpj>77777777777</CpfCnpj> <DsNome>Nome Signatário</DsNome> <DsEmail>signatario1@assinaweb.com.br</DsEmail> <DsTelefoneContato>1132056000</DsTelefoneContato> <TpAssinatura>ELETRO</ TpAssinatura > <Perfil>S</ Perfil > </ participante > </ participantes > </documento> </AssinaWeb>

Exemplo em PHP

<?php

$pdf_base64 = "contrato_manutencao.pdf";

$md5file = md5_file($pdf_base64);

//Get File content from txt file

$pdf_base64_handler = fopen($pdf_base64,'r');

$pdf_content = fread ($pdf_base64_handler,filesize($pdf_base64));

fclose ($pdf_base64_handler);

// converter de string to base64binary

$pdf_encoded = base64_encode ($pdf_content);

//Conteúdo XML do Serviço “PublicarDocumento”

$varxml = '<AssinaWeb VersaoDados="1.00">

<TpAmbiente>H</TpAmbiente>

<CpfCnpjPublicador>11222333000110</CpfCnpjPublicador>

<ContaPublicacao>12345</ContaPublicacao>

<IdChaveAcesso>MuahIhRWM+dIvbT1veqJ58PoIaqxaf/NZdT45ao6NBk=</IdChaveAcesso>

<documento>

<DsDocumento> Teste 1310E #1</DsDocumento>

<DsDetalhesDocumento><![CDATA[Teste carga]]></DsDetalhesDocumento>

<DtLimiteAssinatura>2016-12-12 18:41:16</DtLimiteAssinatura>

<InStatusDocumento></InStatusDocumento>

<InEmailEventos>S</InEmailEventos>

<DsSenhaDocumento>123</DsSenhaDocumento>

<MD5Documento>' . $md5file . '</MD5Documento>

<InMarcaDagua>S</InMarcaDagua>

<participantes>

<participante>

<CpfCnpj>77777777777</CpfCnpj>

<DsNome>Nome Signatário</DsNome>

<DsEmail>signatario1@assinaweb.com.br</DsEmail>

<DsTelefoneContato>1132056000</DsTelefoneContato>

<TpAssinatura>ELETRO</ TpAssinatura >

(24)

Versão 1.15 –

13/11/2020

Pág. 24

<Perfil>S</ Perfil >

</ participante >

</ participantes >

</documento>

</AssinaWeb>';

require_once('C:\xampp\php\PEAR\lib\nusoap.php');

$proxyhost = isset($_POST['proxyhost']) ? $_POST['proxyhost'] : '';

$proxyport = isset($_POST['proxyport']) ? $_POST['proxyport'] : '';

$proxyusername = isset($_POST['proxyusername']) ? $_POST['proxyusername']

: '';

$proxypassword = isset($_POST['proxypassword']) ? $_POST['proxypassword']

: '';

$useCURL = isset($_POST['usecurl']) ? $_POST['usecurl'] : '0';

$client = new

nusoap_client("https://homol.assinaweb.com.br/webservices/publicacaodocum

entos.asmx?wsdl", true, $proxyhost, $proxyport,

$proxyusername,$proxypassword);

$client->soap_defencoding = 'UTF-8';

$client->decode_utf8 = false;

$err = $client->getError();

if ($err) {

echo '<h2>Constructor error</h2><pre>' . $err . '</pre>';

echo '<h2>Debug</h2><pre>' .

htmlspecialchars($client->getDebug(), ENT_QUOTES) . '</pre>';

exit();

}

$client->setUseCurl($useCURL);

// This is an archaic parameter list

$params = array(

'XmlDocumento' => $varxml,

'pdfBase64' => $pdf_encoded

);

$result = $client->call("PublicarDocumento", $params );

if ($client->fault) {

echo '<h2>Fault (Expect - The request contains an invalid SOAP

body)</h2><pre>'; print_r($result); echo '</pre>';

} else {

$err = $client->getError();

if ($err) {

echo '<h2>Error</h2><pre>' . $err . '</pre>';

} else {

echo '<h2>Result</h2><pre>'; print_r($result); echo

'</pre>';

}

echo '<h2>Request</h2><pre>' . htmlspecialchars($client->request,

ENT_QUOTES) . '</pre>';

echo '<h2>Response</h2><pre>' . htmlspecialchars($client->response,

ENT_QUOTES) . '</pre>';

echo '<h2>Debug</h2><pre>' . htmlspecialchars($client->getDebug(),

ENT_QUOTES) . '</pre>';

(25)