Sistema Protocolo Integrado - Serviços

• Listar Assinaturas do Documento do Protocolo (Efetua a consulta da lista da Assinaturas do Documento do Protocolo)

Voltar

Requisição

Escopo

Path Parameters

Campo	Formato	Tamanho	Obrigatório	Descrição
protocolo	string	9 ou 12	Sim	Número do protocolo. Exemplo: 123456789 (sem máscara) ou 12.345.678-9 (com máscara).
codigo	string	-	Sim	Código do documento. Exemplo: 1234. Obs.: Código do documento pode ser obtido pelo serviço Listar Documentos do Protocolo.

Header Parameters

Campo	Formato	Tamanho	Obrigatório	Descrição
Authorization	string	4000	Sim	Token Central de Segurança (formato JWT) para validação do sistema de acesso. Opções: Token do tipo client_credentials ou do tipo authorization_code.
consumerId	string	200	Sim	Consumidor API Gateway para identificação do sistema de acesso. Exemplo: SPIWEB. Como obter as credenciais para consumir os serviços?

Exemplo de Código

Exemplo de Retorno (application/json)

• Listar Assinaturas do Documento do Volume do Processo (Efetua a consulta da lista de Assinaturas do Documento do Volume do Processo)

Voltar

Requisição

Escopo

Path Parameters

Campo	Formato	Tamanho	Obrigatório	Descrição
protocolo	string	9 ou 12	Sim	Número do protocolo. Exemplo: 123456789 (sem máscara) ou 12.345.678-9 (com máscara).
codigo	string	-	Sim	Código do documento. Exemplo: 1234. Obs.: Código do documento pode ser obtido pelo serviço Listar Documentos do Volume do Processo.

Header Parameters

Campo	Formato	Tamanho	Obrigatório	Descrição
Authorization	string	4000	Sim	Token Central de Segurança (formato JWT) para validação do sistema de acesso. Opções: Token do tipo client_credentials ou do tipo authorization_code.
consumerId	string	200	Sim	Consumidor API Gateway para identificação do sistema de acesso. Exemplo: SPIWEB. Como obter as credenciais para consumir os serviços?

Exemplo de Código

Exemplo de Retorno (application/json)

• Incluir Assinatura Externa no Documento do Protocolo (Efetua a inclusão da assinatura externa/CAdES no Documento do Protocolo)

Voltar

Requisição

Escopo

Path Parameters

Campo	Formato	Tamanho	Obrigatório	Descrição
protocolo	string	9 ou 12	Sim	Número do protocolo. Exemplo: 123456789 (sem máscara) ou 12.345.678-9 (com máscara).
codigo	string	-	Sim	Código do documento. Exemplo: 1234. Obs.: Código do documento pode ser obtido pelo serviço Listar Documentos do Protocolo.

Header Parameters

Campo	Formato	Tamanho	Obrigatório	Descrição
Authorization	string	4000	Sim	Token Central de Segurança (formato JWT) para validação do sistema de acesso. Opções: Token do tipo client_credentials ou do tipo authorization_code.
consumerId	string	200	Sim	Consumidor API Gateway para identificação do sistema de acesso. Exemplo: SPIWEB. Como obter as credenciais para consumir os serviços?

Query Parameters

Campo	Formato	Tamanho	Obrigatório	Descrição
assincrono	string	-	Não	Ativa o modo assíncrono da requisição. Opções: true ou false.

Body Parameters (multipart/form-data)

Campo	Formato	Tamanho	Obrigatório	Descrição
md5Arquivo	string	32	Sim	Hash MD5 do arquivo (P7S). Exemplo: fa58b407de3639c721a73d51fce4270d
binarioArquivo	array (file)	100MB	Sim	Binário do arquivo (P7S).

Exemplo de Código

Exemplo de Retorno (application/json)

• Incluir Assinatura Externa no Documento do Volume do Processo (Efetua a inclusão da assinatura externa/CAdES no Documento do Volume do Processo)

Voltar

Requisição

Escopo

Path Parameters

Campo	Formato	Tamanho	Obrigatório	Descrição
protocolo	string	9 ou 12	Sim	Número do protocolo. Exemplo: 123456789 (sem máscara) ou 12.345.678-9 (com máscara).
codigo	string	-	Sim	Código do documento. Exemplo: 1234. Obs.: Código do documento pode ser obtido pelo serviço Listar Documentos do Volume do Processo.

Header Parameters

Campo	Formato	Tamanho	Obrigatório	Descrição
Authorization	string	4000	Sim	Token Central de Segurança (formato JWT) para validação do sistema de acesso. Opções: Token do tipo client_credentials ou do tipo authorization_code.
consumerId	string	200	Sim	Consumidor API Gateway para identificação do sistema de acesso. Exemplo: SPIWEB. Como obter as credenciais para consumir os serviços?

Query Parameters

Campo	Formato	Tamanho	Obrigatório	Descrição
assincrono	string	-	Não	Ativa o modo assíncrono da requisição. Opções: true ou false.

Body Parameters (multipart/form-data)

Campo	Formato	Tamanho	Obrigatório	Descrição
md5Arquivo	string	32	Sim	Hash MD5 do arquivo (P7S). Exemplo: fa58b407de3639c721a73d51fce4270d
binarioArquivo	array (file)	100MB	Sim	Binário do arquivo (P7S).

Exemplo de Código

Exemplo de Retorno (application/json)

Voltar