- Conteúdo da página
- Introdução
- Formato de entrada
- Formato de Saida
Chamada: ObterP7SDoc
Esta função tem por objetivo exportar os arquivos abaixo após terem sido coletadas todas as assinaturas/aprovações.
- Se documento contém assinatura em formato CADES serão exportados os seguintes arquivos:
- Arquivo Original;
- Arquivo com marca d´água e protocolo contendo todas as aprovações e assinaturas (com e sem certificado digital);
- Arquivo com extensão .P7S que é o arquivo que contém o pacote assinado digitalmente. Isto é, contém o arquivo ou o hashcode do arquivo assinado e todos os certificados digitais que o assinaram.
- Se documento contém assinatura em formato PADES serão exportados os seguintes arquivos:
- Arquivo original com todas as assinaturas com certificado digital. O pacote assinado é o próprio arquivo original;
- Arquivo com marca d´água e protocolo contendo todas as aprovações e assinaturas (com e sem certificado digital).
Formato de entrada:
- Utilizando referência:
<?xml version="1.0" encoding="ISO-8859-1" ?>
<documentoeletronico>
<sessao>XXXX</sessao>
<docto_sistema_codigo>10</docto_sistema_codigo>
<referencia>XX</referencia>
<arquivo_original>S</arquivo_original>
<arquivo_protocolo>S</arquivo_protocolo>
</documentoeletronico>
- Utilizando passcode:
<?xml version="1.0" encoding="ISO-8859-1" ?>
<documentoeletronico>
<sessao>XXXX</sessao>
<docto_sistema_codigo>10</docto_sistema_codigo>
<passcode>RKILF-FG4FR-TCDEW-57RFE</passcode>
<arquivo_original>S</arquivo_original>
<arquivo_protocolo>S</arquivo_protocolo>
</documentoeletronico>
Parâmetro | Formato | Obrigatório | Descrição |
---|---|---|---|
sessao | Texto | S | Chave de acesso cadastrada para sua empresa. |
docto_sistema_codigo | Númerico | S |
Tipo de documento: (se não informado, assume-se o valor 5) 5 - Contrato Eletrônico 10 - Laudo Digital |
referencia | Texto | S | Referência de um documento. |
passcode | Texto | S | Passcode de um documento. Passcode é a identificação de um documento gerada pelo Portal QualiSign. |
arquivo_original | Texto | S | Indica se também quer o arquivo original (S-Sim, N-Não). |
arquivo_protocolo | Texto | S | Indica se também quer o Protocolo (S-Sim, N-Não)
Se o arquivo for um PDF, será retornado um arquivo PDF contendo o arquivo original com rodapé indicando que foi assinado digitalmente na última página do documento, o protocolo. No caso de outros formatos, retornará somente o PDF com o protocolo. |
Formato de saída:
<?xml version="1.0" encoding="ISO-8859-1" ?>
<documentoeletronico>
<CodErro />
<MsgErro />
<P7SBase64></P7SBase64>
<ArquivoOriginalBase64></ArquivoOriginalBase64>
<NomeArquivo></NomeArquivo>
<ArquivoProtocoloBase64></ArquivoProtocoloBase64>
<NomeArquivoProtocolo></NomeArquivoProtocolo>
<observações>
<observação></observação>
<observações>
</documentoeletronico>
Parâmetro | Formato | Descrição |
---|---|---|
CodErro | Numérico | Código de erro (ver Códigos de Erros). |
MsgErro | Texto | Mensagem de Erro |
P7SBase64 | Texto | Conteúdo do arquivo P7S em Base 64 (quando assinado com certificado digital). |
ArquivoOriginalBase64 | Texto | Conteúdo do arquivo original em Base 64 (quando armazenado no Portal). |
NomeArquivo | Texto | Nome do arquivo original armazenado |
ArquivoProtocoloBase64 | Texto | Protocolo de assinatura ou quando se tratar de PDF, o arquivo contendo o rodapé indicando que foi assinado eletronicamente e contendo como última página o protocolo (em Base 64). |
NomeArquivoprotocolo | Texto | Nome do arquivo contendo o protocolo. |
observacao | Texto | Mensagem de aviso referente ao processo de exportação, quando um dos artefatos não esteja disponivel. Por ser possível exportar documentos que não necessariamente tenham assinatura digital (arquivo p7s), ou que não possuam arquivo original, esta TAG poderá retornar as seguintes mensagens:
· “Não existe p7s para este documento”; · “Arquivo Original não armazenado no portal”. |