search

Importar Documentos

Insere na solicitação informada os documentos informados. (Opcional)

hashtag
importar-documentos

POST <base_url>/videoconferencia-api/importar-documentos

hashtag
Headers

Name
Type
Description

HMAC-Authentication*

String

Resultado do cálculo HMAC

Content-Type*

String

application/json

hashtag
Request Body

Name
Type
Description

docs*

String

JSON contendo os documentos

senha*

String

Senha de Emissão do Certificado Digital

protocolo*

String

Número do Pedido/Voucher

{
    "protocolo": "22714-25",
    "docs": [
        "CNH",
        "RG"
    ]
}
circle-info

O conteúdo do body deverá estar em formato JSON.

O body deverá conter os seguintes itens:

  • protocolo: Número do Protocolo. O número é retornado no serviço nova-solicitacaoarrow-up-right.

  • senha: Senha configurável definida n

  • o Certificado. A mesma enviada no serviço nova-solicitacaoarrow-up-right.

  • docs: Array de objetos contendo os dados do documento a ser anexado.

    • name: Nome do documento com a extensão.

    • extensao: Extensão do arquivo. (Extensões permitidas: PDF - JPEG -PNG)

    • file: Base64arrow-up-right do arquivo.

hashtag
Exemplo do body

circle-exclamation

hashtag
Regras de utilização da chave senha

  1. Se no serviço nova-solicitacao foi enviada a chave senha

    • O mesmo valor deverá ser informado neste serviço, também na chave senha.

    Exemplo:

  2. Se no serviço nova-solicitacao foi enviada a chave senhaTemp

    • O valor informado em senhaTemp deverá ser enviado neste serviço na chave senha.

    Exemplo:

circle-info

No exemplo da montagem do body em PHP, na linha 8 e 13 é calculado o base64 dos arquivos a serem enviados.

hashtag
Código de Exemplo

circle-info

Só é possível enviar os documentos se a solicitação estiver na situação: Cancelada ou Em Edição. Para ver a situação atual da solicitação faça uma requisição ao serviço Consulta Dados Solicitaçãoarrow-up-right. A chave HMAC utilizada é diferente da chave HMAC dessa API.

hashtag
Resposta esperada - HTTP Status Code 200

hashtag
Descrição dos campos

  • protocolo: Protocolo do agendamento.

  • docs: Array com os nomes dos documentos anexados.

Fluxo do Agendamento da Videoconferência concluído com sucesso!

PreviousAgendar Videconferência

Last updated