WS014 - Cadastrar Usuários na Comprovei

Objetivo

Esta integração tem por objetivo permitir o cadastro de um ou mais usuários no Comprovei©.

Descrição do método


`Método`	uploadUsers
`WSDL principal`	https://soap.comprovei.com.br/importQueue/index.php?wsdl
`WSDL de contingencia`	https://soapcontingencia.comprovei.com.br/importQueue/index.php?wsdl
`XSD`	https://soap.comprovei.com.br/importQueue/schemas/uploadUsers.xsd

Importante

A conexão ao nosso serviço deve ser feito ao nosso servidor principal, porém sugerimos fortemente que também seja disponibilizada uma conexão ao nosso servidor de contingência, como garantia de disponibilidade dos nossos serviços. O servidor de contingência só é ligado em situações de indisponibilidade do nosso servidor principal. Tornar parametrizável a url de conexão também é uma boa prática;
Nossas conexões são seguras utilizando o protocolo SSL. Por questão de segurança nossos certificados são alterados constantemente e sem aviso prévio. Portanto é recomendável que não desenvolvam as integrações baseadas em um certificado fixo.
Constantemente (e sem aviso prévio) adicionamos novos campos e estruturas tanto nas requisições quanto nas respostas dos nossos webservices. Quem for utilizar nossos webservices deve implementar de tal maneira que os programas que consomem estes webservices não deixem de funcionar quando houver as alterações de campos mencionadas.

Características

As chamadas serão realizadas via SOAP sobre HTTPS;
A origem do chamado do Web Service será o sistema do cliente;

Importante

O usuário deste Web Service deve armazenar o protocolo gerado na resposta. Chamados de suporte referentes a esta integração irão necessitar deste protocolo.

Autenticação

As chamadas terão autenticação a nível de transporte (Basic Authentication);
Solicite o user / password ao administrador da conta.

Exemplo cabeçalho HTTP com a autenticação

POST https://soap.comprovei.com.br/importQueue/index.php HTTP/1.1
Accept-Encoding: gzip,deflate
Content-Type: text/xml;charset=UTF-8
SOAPAction: "urn:WebServiceComprovei#uploadUsers"
Authorization: Basic BASE64(user:password)
Content-Length: {quantidade de bytes enviados}
Host: soap.comprovei.com.br
Connection: Keep-Alive
User-Agent: Apache-HttpClient/4.1.1 (java 1.5)

Request

A requisição para o nosso Web Service é composta da seguinte forma:

TAG	Tipo	Descrição
`conteudoArquivo`	string	Conteúdo do arquivo XML codificado em Base64. Ver seção 'Nosso XML de Usuários'.
`nomeArquivo`	string	Nome do arquivo enviado, com a extensão. Exemplo: usuarios.xml

Exemplo de Request

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:WebServiceComprovei">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:uploadUsers soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <conteudoArquivo xsi:type="xsd:string">PFVzdWFyaW9zPgogICAgPFVzdWFyaW8+CiAgICAgICAgPEhhYmlsaXRhcj4wPC9IYWJpbGl0YXI+CiAgICAgICAgPExvZ2luPjEyMzQ1Njc4OTAxPC9Mb2dpbj4KICAgICAgICA8U2VuaGE+MTIzNDwvU2VuaGE+CiAgICAgICAgPEVtYWlsPjwvRW1haWw+CiAgICAgICAgPFRpcG9Vc3VhcmlvPjI8L1RpcG9Vc3VhcmlvPgogICAgICAgIDxOb21lQ29tcGxldG8+Tm9tZUNvbXBsZXRvRG9Nb3RvcmlzdGE8L05vbWVDb21wbGV0bz4KICAgICAgICA8VGVsZWZvbmU+MFhYMTIzNDU2Nzg5PC9UZWxlZm9uZT4KICAgICAgICA8TnVtQ05IPk51bWVyb0NOSE1vdG9yaXN0YTwvTnVtQ05IPgogICAgICAgIDxWZW5jdG9DTkg+MjAxOS0wMS0wNzwvVmVuY3RvQ05IPgogICAgICAgIDxSZWdpb2VzPlJlZ2lvZXNTZXBhcmFkYXNQb3JWaXJndWxhPC9SZWdpb2VzPgogICAgICAgIDxUcmFuc3BvcnRhZG9yYXM+Q05QSnNTZXBhcmFkb3NQb3JWaXJndWxhPC9UcmFuc3BvcnRhZG9yYXM+CiAgICAgICAgPEVtYmFyY2Fkb3Jlcz5DTlBKc1NlcGFyYWRvc1BvclZpcmd1bGE8L0VtYmFyY2Fkb3Jlcz4KICAgIDwvVXN1YXJpbz4KPC9Vc3Vhcmlvcz4=</conteudoArquivo>
        <nomeArquivo xsi:type="xsd:string">usuarios.xml</nomeArquivo>
      </urn:uploadUsers>
   </soapenv:Body>
</soapenv:Envelope>

Response

Nosso Web Service responde para você da seguinte forma:

TAG	Tipo	Descrição
`status`	string	Mensagem de sucesso ou de erro para a chamada do método.
`protocolo`	string	Protocolo para consultar a evolução do pedido de importação.

Protocolo

Quando um arquivo é aceito no nosso sistema, um protocolo é gerado para que o processo de importação seja acompanhado. Isso pode ser feito utilizando o método WS501.

Exemplo de Response

<SOAP-ENV:Envelope SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="urn:WebServiceComprovei" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/">
   <SOAP-ENV:Body>
      <ns1:uploadUsersResponse>
         <status xsi:type="xsd:string">Arquivo adicionado para a fila de importação!</status>
         <protocolo xsi:type="xsd:string">2017022258add9af06990</protocolo>
      </ns1:uploadUsersResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Nosso XML de Usários

Nosso XML para cadastrar usuários é composto pelas seguintes TAGs:

TAG	Tipo	Obrigatório	Descrição
`Usuarios`	root	Sim	Raiz do xml e composto por um ou mais Usuario.

Usuario

TAG	Tipo	Obrigatório	Descrição
`Habilitar`	integer	Sim	Indica se o usuário será habilitado, caso houver licença para tal.
`Login`	string	Sim	Login do usuário para utilizar no sistema.
`Senha`	string	Sim	Senha do usuário para utilizar no sistema.
`Email`	string	Não	Email do usuário.
`TipoUsuario`	integer	Sim	Tipo de usuário a ser cadastrado (Ver tabela Tipo de Usuário).
`NomeCompleto`	string	Sim	Nome completo do usuário.
`Telefone`	string	Não	Telefone do usuário.
`NumCNH`	string	Não	Número da CNH do usuário (somente motorista).
`VenctoCNH`	string	Não	Data de vencimento da CNH do usuário (somente motorista). Formato: YYYY-MM-DD.
`Regioes`	string	Não	Nome da Região para filtro automático no Console. Pode ser enviado mais de uma região, separado por virgula.
`Transportadoras`	string	*	CNPJ da Transportadora para filtro no console. Pode ser enviado mais de um CNPJ, separado por virgula.
`Embarcadores`	string	*	CNPJ do Embarcador para filtro no console. Pode ser enviado mais de um CNPJ, separado por virgula.
`AutenticacaoDoisFatores`	string	Não	Tipo de autenticação a ser utilizada no login (Não se aplica a motoristas)
`CPF`	string	Não	CPF do usuário, utilizado para identificação e validação (principalmente em motoristas).

*

Caso o usuário a ser cadastrado seja do tipo Transportador ou Embarcador, é necessário enviar o(s) CNPJ(s) do transportador ou embarcador ao qual ele pertence.

Autenticacao de dois fatores

Código	Descrição
`Vazio*`	Nenhum
`Email`	Recebe código de autenticação por email

*

Enviar a tag em branco, caso não deseje autenticação de dois fatores.

Tipos de Usuário

Código	Descrição
`2`	Usuário motorista.
`3`	Usuário desktop.
`5`	Usuário supervisor.
`11`	Usuário transportador.
`12`	Usuário embarcador.

Estrutura completa de exemplo

Clique aqui para ver o exemplo

<?xml version="1.0" encoding="utf-8"?>
<Usuarios>
  <Usuario>
      <Habilitar>1</Habilitar>
      <Login>12345678901</Login>
      <Senha>1234</Senha>
      <Email></Email>
      <TipoUsuario>2</TipoUsuario>
      <NomeCompleto>NomeCompletoDoMotorista</NomeCompleto>
      <Telefone>0XX123456789</Telefone>
      <NumCNH>NumeroCNHMotorista</NumCNH>
      <VenctoCNH>2019-01-07</VenctoCNH>
      <Regioes>RegioesSeparadasPorVirgula</Regioes>
      <Transportadoras>CNPJsSeparadosPorVirgula</Transportadoras>
      <Embarcadores>CNPJsSeparadosPorVirgula</Embarcadores>
      <AutenticacaoDoisFatores></AutenticacaoDoisFatores>
  </Usuario>
</Usuarios>