Nova Solicitação

Cria uma solicitação de Certificado Digital com o Produto e os dados do Cliente informado.

nova-solicitacao

POST <base_url>/videoconferencia-api/nova-solicitacao

Headers

Name	Type	Description
HMAC-Authentication*	String	Resultado do cálculo HMAC
Content-Type*	String	application/json

Request Body

Name	Type	Description
produto*	String	JSON contendo os dados do Produto
municipio*	String	JSON contendo o código IBGE
cliente*	String	JSON contendo os dados do Cliente
pedido*	String	Número do Pedido/Voucher
codigo_aceite	String	Código de aceite
custom_fields_email	String	JSON contendo os campos personalizáveis para email de alianças

201: Created

{
    "codigo": "113D211018389168",
    "protocolo": "22704-21",
    "message": "Solicitação cadastrada com sucesso."
}

400: Bad Request

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

O body deverá conter os seguintes itens:

• pedido: Número do Pedido/Voucher (Obrigatório)

• cliente: Objeto com os dados do Cliente (Obrigatório)

  • nome: Nome completo do Cliente (Obrigatório)

  • email: E-mail do Cliente (Obrigatório)

  • telefone: Número do celular do Cliente (Obrigatório)

  • cpf: Número do CPF do Cliente (Obrigatório)

  • cnpj: Número do CNPJ do Cliente (Obrigatório quando produto for tipo : J)

  • cnh: Número da CNH do Cliente (Opcional)

  • senha: Senha de Emissão do Certificado (Configurável)

  • senhaTemp: Senha temporária da Solicitação (Configurável)

• municipio: Objeto com o código IBGE do Município (Obrigatório)

  • codigo: Código IBGE do Município do endereço do Cliente (Obrigatório)

• produto: Objeto com o Produto que será utilizado na solicitação do Certificado Obrigatório)

  • idproduto: O mesmo retornado no serviço importar-pedido (Obrigatório)

  • nome: O mesmo retornado no serviço importar-pedido (Obrigatório)

  • tipo: O mesmo retornado no serviço importar-pedido (Obrigatório)

  • perfiliti: O mesmo retornado no serviço importar-pedido (Obrigatório)

  • validade: O mesmo retornado no serviço importar-pedido (Obrigatório)

  • sequencia: O mesmo retornado no serviço importar-pedido (Obrigatório)

  • isExtProdutoAc: O mesmo retornado no serviço importar-pedido (Obrigatório)

  • extProduto: O mesmo retornado no serviço importar-pedido (Obrigatório)

  • extProdutoAc: O mesmo retornado no serviço importar-pedido (Obrigatório)

  • campo1: O mesmo retornado no serviço importar-pedido (Obrigatório)

  • campo2: O mesmo retornado no serviço importar-pedido (Obrigatório)

  • campo3: O mesmo retornado no serviço importar-pedido (Obrigatório)

• codigo_aceite: Código de aceite retornado no serviço gera-codigo-aceite

• custom_fields_email : Objeto com os campos customizáveis para emails de alianças

  • logo_ar : Logo da Autoridade de Registro para ser exibido nos emails de: Agendamento do lembrete de videoconferência, Lembrete de videoconferencia, Confirmação de identidade, Termo de titularidade e Aprovação de Certificado.

  • logo_email : Logo principal para ser exibido nos emails de: Agendamento do lembrete de videoconferência, Lembrete de videoconferencia e Termo de titularidade.

  • logo_email_approved : Logo principal para ser exibido no email de Aprovação de Certificado.

  • logo_button_approved : Logo do botão de Instalação do certificado para ser exibido no email de Aprovação de Certificado.

  • link_email_approved : Link do botão de Instação do certificado para ser exibido no email de Aprovação de Certificado. Os parâmetros "{protocolo}" e "{solicitacao}" serão preenchidos automaticamente. Ex.: https://soluti.com.br/instalar-certificado/{protocolo}/{solicitacao}

  • link_faq : Link de suporte para ser exibido nos emails de: Lembrete de videoconferencia e Termo de titularidade.

  • fone_faq : Fone de suporte para ser exibido nos emails de: Lembrete de videoconferencia e Termo de titularidade.

Envio da senha na emissão do Certificado Digital

Por padrão, o envio da chave senha é obrigatória no serviço. Para torná-la opcional, é necessário solicitar a ativação do envio opcional da senha.

Após a ativação:

• Senha não enviada: Caso a chave senha esteja ausente, a chave senhaTemp se torna obrigatória. A chave senhaTemp será utilizada para as etapas de Agendar Videoconferência e Importar Documentos. Obs.: Durante a videoconferência, será gerada automaticamente uma senha aleatória, que o cliente deverá utilizar para a emissão do Certificado Digital

• Senha enviada: Caso a chave senha seja enviada, ela será a utilizada nas etapas de Agendar Videoconferência, Importar Documentos e Emissão do Certificado Digital, dispensando o envio da chave senhaTemp .

Observação

O comportamento definido acima será preservado e aplicado nas etapas seguintes do processo:

• Agendar Videconferência

• Importar Documentos

Deve ser enviado uma string vazia para os itens não obrigatórios. Exemplo: cnh : ''

Exceto para o codigo_aceite que pode ou não ser definido no body, se for enviado devera conter seu respectivo valor.Exemplo:codigo_aceite : '34B81E'

Exemplo do body

Exemplo do body em formato JSON

{
    "pedido": "00034d60c265",
    "cliente": {
        "nome": "BRUNO BARROS",
        "email": "[e-mail]",
        "telefone": "62999999999",
        "cpf": "50974101060",
        "cnpj": "94632451000195",
        "cnh": "",
        "senha": "SoLuTI@123",
        
    },
    "municipio": {
        "codigo": "5208707"
    },
    "produto": {
        "idproduto": 245,
        "nome": "ACS PJ A1 V5",
        "tipo": "J",
        "perfiliti": "A1 PJ",
        "validade": 12,
        "sequencia": 1,
        "isExtProdutoAc": false,
        "extProduto": 10,
        "extProdutoAc": 0,
        "campo1": "20210726;20210726;VD",
        "campo2": null,
        "campo3": null
    },
    "codigo_aceite": "34B81E",
    "custom_fields_email": {
        "logo_ar" : "https://arsoluti.acsoluti.com.br/public/remote-upload/arsoluti-site.png",
        "logo_email" : "http://cdn.mcauto-images-production.sendgrid.net/f7ec6a3140871c72/7c215b30-bf02-4639-929d-6a3803193b11/166x150.png",
        "logo_email_approved" : "http://cdn.mcauto-images-production.sendgrid.net/f7ec6a3140871c72/7e112983-ffb4-44e4-a133-4c87e6a93ab7/322x310.png",
        "logo_button_approved" : "http://cdn.mcauto-images-production.sendgrid.net/f7ec6a3140871c72/1f619cf3-d377-4045-a7d0-c92cff469bc2/168x32.png",
        "link_email_approved" : "https://https://emissao-online.soluti.com.br/solicitacao/{solicitacao}/protocolo/{protocolo}",
        "link_faq" : "https://soluti.com.br/faq",
        "fone_faq" : "0800 999 9999"
    }
}

Exemplo do body em PHP

No exemplo da montagem body em PHP, a variável $produtos é um array contendo o conteúdo da chave produtos retornado no serviço importar-pedido. Caso o Pedido/Voucher tenha mais de um produto o Cliente deverá selecionar somente um produto.

Na variável $codigo_aceite contem o valor da código gerado e retornado no serviço gera-codigo-aceite.

Código de Exemplo

PHP

<?php
require_once 'HTTP/Request2.php';

$base_url = 'https://arsolutihom.acsoluti.com.br';
$uri = "{$base_url}/videoconferencia-api/nova-solicitacao";
$method = "POST";
$hmacVersion = 1;
$clientId = 0;

$mensagem = array(
    'pedido' => '00034d60c265',
    'cliente' => array(
        'nome' => 'BRUNO BARROS',
        'email' => '[e-mail]',
        'telefone' => '62999999999',
        'cpf' => '50974101060',
        'cnpj' => '94632451000195',
        'cnh' => '',
        'senha' => 'SoLuTI@123',
    ),
    'municipio' => array(
        'codigo' => '5208707'
    ),
    'produto' => $produtos[0],
    'codigo_aceite' => $codigo_aceite,
    'custom_fields_email' => array( 
        'logo_ar' => 'https://arsoluti.acsoluti.com.br/public/remote-upload/arsoluti-site.png',
        'logo_email' => 'http://cdn.mcauto-images-production.sendgrid.net/f7ec6a3140871c72/7c215b30-bf02-4639-929d-6a3803193b11/166x150.png',
        'logo_email_approved' => 'http://cdn.mcauto-images-production.sendgrid.net/f7ec6a3140871c72/7e112983-ffb4-44e4-a133-4c87e6a93ab7/322x310.png',
        'logo_button_approved' => 'http://cdn.mcauto-images-production.sendgrid.net/f7ec6a3140871c72/1f619cf3-d377-4045-a7d0-c92cff469bc2/168x32.png',
        'link_email_approved' => 'https://https://emissao-online.soluti.com.br/solicitacao/{solicitacao}/protocolo/{protocolo}',
        'link_faq' => 'https://soluti.com.br/faq',
        'fone_faq' => '0800 999 9999'
    )
);

$m = json_encode($mensagem);

$ds = $method . $uri . $m;

$key = 'CHAVESECRETAAPI';
$nonce = time();
$hkey = $nonce . $key;
$hmac = hash('sha256', hash('sha256', $hkey) . hash('sha256', $hkey . $ds));

$headers = [
    'Content-type' => 'application/json',
    'HMAC-Authentication' => $hmacVersion . ':' . $clientId . ':' . $nonce . ':' . $hmac
];

$request = new HTTP_Request2();
$request->setUrl($uri);
$request->setMethod(HTTP_Request2::METHOD_POST);
$request->setHeader($headers);
$request->setBody($m);

$response = $request->send();

echo $response->getBody();

Resposta esperada - HTTP Status Code 201

Resposta em formato JSON

{
    "codigo": "113D211018389168",
    "protocolo": "22704-21",
    "message": "Solicitação cadastrada com sucesso."
}

Salve o valor da chave protocolo, ele será necessário nas próximas etapas.

Caso queira visualizar os dados da solicitação criada, consuma o serviço Consulta Dados Solicitação utilizando o valor da chave codigo. A chave HMAC utilizada é diferente da chave HMAC dessa API.

Descrição dos campos

• codigo: Código da solicitação do Certificado Digital.

• protocolo: Código do protocolo para realizar o agendamento da videoconferência.

• message: Mensagem de confirmação.

Horários Disponíveis