O objetivo desta Instrução de Trabalho (IT) é apresentar o modo e como funciona a integração de abertura de ocorrências.
Utilizamos o SOAP (Protocolo Simples de Acesso a Objetos) para realizar as integrações, facilitando a comunicação com qualquer tipo de aplicação disponível no mercado seja ela Web ou Client Server.
O nosso serviço de integração é disponibilizado junto com a aplicação web e nossos webservices pode ser encontrado na opção dentro do sistema em Serviços>Webservices apenas disponíveis para os administradores do sistema.
As informações dos serviços disponíveis ficam em https://www.[caminho do seu sistema]/webservices, Neste endereço, irá encontrar diversos métodos de integrações. Para a Integração de Abertura de Ocorrência, utilizaremos o Método Dados ServiceDesk.
Ao clicar no método poderá verificar todos os parâmetros disponíveis.
No final do documento há um link para a Página de Teste dos Formulários.
Este formulário permite realizar teste com seus dados e verificar se o webservice está funcionando corretamente. Este formulário contém a informação de qual campo é obrigatório e seus respectivos formatos.
Ao final do formulário são listados todos os campos do webservice com suas descrições.
Ao gerar o XML de comunicação, é importante não alterar a ordem dos campos, nem tampouco removê-los. Deixe-os com valor nulo ou no máximo como uma string vazia se não for possível manda-los como nulo.
Atente-se à obrigatoriedade de certos campos. Caso tenha dúvida sobre quais informações devem ser passadas, entre em contato com a consultoria da Multidados.
<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:server.Multidados" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"> <soapenv:Header/> <soapenv:Body> <urn:DadosServicedesk soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"> <USUARIO_WS xsi:type="xsd:string">usuario_webservice</USUARIO_WS> <SENHA_WS xsi:type="xsd:string">senha_webservice</SENHA_WS> <CNPJ_EMPRESA xsi:type="xsd:string"></CNPJ_EMPRESA> <COD_DIVISAO xsi:type="xsd:string">CRM-001</COD_DIVISAO> <COD_SOLICITACAO xsi:type="xsd:string">FIN001</COD_SOLICITACAO> <COD_PROJETO xsi:type="xsd:string"></COD_PROJETO> <DESCRICAO xsi:type="xsd:string">Este é um teste de Webservices</DESCRICAO> <DESCRICAO_SOLUCAO xsi:type="xsd:string"></DESCRICAO_SOLUCAO> <DATA_ABERTURA xsi:type="xsd:string"></DATA_ABERTURA> <DATA_FECHAMENTO xsi:type="xsd:string"></DATA_FECHAMENTO> <DATA_ATENDIMENTO xsi:type="xsd:string"></DATA_ATENDIMENTO> <DH_PRAZO xsi:type="xsd:string"></DH_PRAZO> <DH_DEFINICAO_PRAZO xsi:type="xsd:string"></DH_DEFINICAO_PRAZO> <COD_ABERTO_POR xsi:type="xsd:string"></COD_ABERTO_POR> <COD_ABERTO_PARA xsi:type="xsd:string">operador_financeiro</COD_ABERTO_PARA> <COD_CLIENTE xsi:type="xsd:string"></COD_CLIENTE> <NOME_CLIENTE xsi:type="xsd:string">Brasil Cob ltda</NOME_CLIENTE> <NOME_FANTASIA xsi:type="xsd:string">BrasilCob</NOME_FANTASIA> <CNPJ_CLIENTE xsi:type="xsd:string">58.795.252/0001-34</CNPJ_CLIENTE> <DT_NASC_CLIENTE xsi:type="xsd:string"></DT_NASC_CLIENTE> <END_CLIENTE xsi:type="xsd:string"></END_CLIENTE> <BAIRRO_CLIENTE xsi:type="xsd:string"></BAIRRO_CLIENTE> <COMPLEMENTO_CLIENTE xsi:type="xsd:string"></COMPLEMENTO_CLIENTE> <CEP_CLIENTE xsi:type="xsd:string"></CEP_CLIENTE> <CIDADE_CLIENTE xsi:type="xsd:string"></CIDADE_CLIENTE> <ESTADO_CLIENTE xsi:type="xsd:string"></ESTADO_CLIENTE> <NUM_END_CLIENTE xsi:type="xsd:string"></NUM_END_CLIENTE> <DDD_RES_CLIENTE xsi:type="xsd:string"></DDD_RES_CLIENTE> <TEL_RES_CLIENTE xsi:type="xsd:string"></TEL_RES_CLIENTE> <DDD_CEL_CLIENTE xsi:type="xsd:string">11</DDD_CEL_CLIENTE> <TEL_CEL_CLIENTE xsi:type="xsd:string">983837284</TEL_CEL_CLIENTE> <DDD_COM_CLIENTE xsi:type="xsd:string">11</DDD_COM_CLIENTE> <TEL_COM_CLIENTE xsi:type="xsd:string">98047-3366</TEL_COM_CLIENTE> <DDD_OUTROS_CLIENTE xsi:type="xsd:string"></DDD_OUTROS_CLIENTE> <TEL_OUTROS_CLIENTE xsi:type="xsd:string"></TEL_OUTROS_CLIENTE> <EMAIL_CLIENTE xsi:type="xsd:string">contato@brasilcob.com.br</EMAIL_CLIENTE> <SEXO_CLIENTE xsi:type="xsd:string"></SEXO_CLIENTE> <EST_CIVIL_CLIENTE xsi:type="xsd:string"></EST_CIVIL_CLIENTE> <QTDE_DEPENDENTES_CLIENTE xsi:type="xsd:string"></QTDE_DEPENDENTES_CLIENTE> <NOME_MAE_CLIENTE xsi:type="xsd:string"></NOME_MAE_CLIENTE> <ESTADO_NASC_CLIENTE xsi:type="xsd:string"></ESTADO_NASC_CLIENTE> <RG_CLIENTE xsi:type="xsd:string"></RG_CLIENTE> <DT_EMISSAO_CLIENTE xsi:type="xsd:string"></DT_EMISSAO_CLIENTE> <ORGAO_EMISSOR_CLIENTE xsi:type="xsd:string"></ORGAO_EMISSOR_CLIENTE> <ESTADO_EMISSOR_CLIENTE xsi:type="xsd:string"></ESTADO_EMISSOR_CLIENTE> <BANCOS_CLIENTES xsi:type="urn:BD_Clientes" SOAP-ENC:arrayType="urn:BD_ClientesStruct[]"/> <NOME_CONTATO xsi:type="xsd:string">José da Silva</NOME_CONTATO> <ATIVO_RECEPTIVO xsi:type="xsd:string"></ATIVO_RECEPTIVO> <COD_CAMPANHA xsi:type="xsd:string"></COD_CAMPANHA> <COD_ORIGEM xsi:type="xsd:string"></COD_ORIGEM> <CAMPOS_VARIAVEIS_CLIENTES xsi:type="urn:CA_Clientes" SOAP-ENC:arrayType="urn:CA_ClientesStruct[]"> <CAMPO_VARIAVEL> <codigo>CA_737</codigo> <valor>cod_nao_atendido</valor> </CAMPO_VARIAVEL> </CAMPOS_VARIAVEIS_CLIENTES> <CAMPOS_VARIAVEIS_OCORRENCIA xsi:type="urn:CA_Clientes" SOAP-ENC:arrayType="urn:CA_ClientesStruct[]"> <CA> <codigo>CA_720</codigo> <valor>Campo de texto livre</valor> </CA> <CA> <codigo>CA_705</codigo> <valor>COD_RESP_1</valor> </CA> <CA> <codigo>CA_717</codigo> <valor>123456</valor> </CA> </CAMPOS_VARIAVEIS_OCORRENCIA> <CAMPOS_VARIAVEIS_PROJETO xsi:type="urn:CA_Clientes" SOAP-ENC:arrayType="urn:CA_ClientesStruct[]"/> <TELEFONES_CLIENTE_FULL xsi:type="urn:CA_Clientes" SOAP-ENC:arrayType="urn:CA_ClientesStruct[]"/> <CLIENTE_CODIGO_AUXILIAR xsi:type="xsd:string"></CLIENTE_CODIGO_AUXILIAR> <DDD_RES2_CLIENTE xsi:type="xsd:string"></DDD_RES2_CLIENTE> <TEL_RES2_CLIENTE xsi:type="xsd:string"></TEL_RES2_CLIENTE> <DDD_CEL2_CLIENTE xsi:type="xsd:string"></DDD_CEL2_CLIENTE> <TEL_CEL2_CLIENTE xsi:type="xsd:string"></TEL_CEL2_CLIENTE> <DDD_COM2_CLIENTE xsi:type="xsd:string"></DDD_COM2_CLIENTE> <TEL_COM2_CLIENTE xsi:type="xsd:string"></TEL_COM2_CLIENTE> <DDD_OUTROS2_CLIENTE xsi:type="xsd:string"></DDD_OUTROS2_CLIENTE> <TEL_OUTROS2_CLIENTE xsi:type="xsd:string"></TEL_OUTROS2_CLIENTE> <DDD_RES3_CLIENTE xsi:type="xsd:string"></DDD_RES3_CLIENTE> <TEL_RES3_CLIENTE xsi:type="xsd:string"></TEL_RES3_CLIENTE> <DDD_CEL3_CLIENTE xsi:type="xsd:string"></DDD_CEL3_CLIENTE> <TEL_CEL3_CLIENTE xsi:type="xsd:string"></TEL_CEL3_CLIENTE> <DDD_COM3_CLIENTE xsi:type="xsd:string"></DDD_COM3_CLIENTE> <TEL_COM3_CLIENTE xsi:type="xsd:string"></TEL_COM3_CLIENTE> <DDD_OUTROS3_CLIENTE xsi:type="xsd:string"></DDD_OUTROS3_CLIENTE> <TEL_OUTROS3_CLIENTE xsi:type="xsd:string"></TEL_OUTROS3_CLIENTE> <DDD_RES4_CLIENTE xsi:type="xsd:string"></DDD_RES4_CLIENTE> <TEL_RES4_CLIENTE xsi:type="xsd:string"></TEL_RES4_CLIENTE> <DDD_CEL4_CLIENTE xsi:type="xsd:string"></DDD_CEL4_CLIENTE> <TEL_CEL4_CLIENTE xsi:type="xsd:string"></TEL_CEL4_CLIENTE> <DDD_COM4_CLIENTE xsi:type="xsd:string"></DDD_COM4_CLIENTE> <TEL_COM4_CLIENTE xsi:type="xsd:string"></TEL_COM4_CLIENTE> <DDD_OUTROS4_CLIENTE xsi:type="xsd:string"></DDD_OUTROS4_CLIENTE> <TEL_OUTROS4_CLIENTE xsi:type="xsd:string"></TEL_OUTROS4_CLIENTE> <DDD_TEL_RES_CLIENTE xsi:type="xsd:string"></DDD_TEL_RES_CLIENTE> <DDD_TEL_CEL_CLIENTE xsi:type="xsd:string"></DDD_TEL_CEL_CLIENTE> <DDD_TEL_COM_CLIENTE xsi:type="xsd:string"></DDD_TEL_COM_CLIENTE> <DDD_TEL_OUTROS_CLIENTE xsi:type="xsd:string"></DDD_TEL_OUTROS_CLIENTE> <DDD_TEL_RES2_CLIENTE xsi:type="xsd:string"></DDD_TEL_RES2_CLIENTE> <DDD_TEL_CEL2_CLIENTE xsi:type="xsd:string"></DDD_TEL_CEL2_CLIENTE> <DDD_TEL_COM2_CLIENTE xsi:type="xsd:string"></DDD_TEL_COM2_CLIENTE> <DDD_TEL_OUTROS2_CLIENTE xsi:type="xsd:string"></DDD_TEL_OUTROS2_CLIENTE> <IDOCORRENCIA xsi:type="xsd:string"></IDOCORRENCIA> <CODIGO_OC xsi:type="xsd:string"></CODIGO_OC> <CODIGO_OC_PAI xsi:type="xsd:string"></CODIGO_OC_PAI> <CODIGO_OP_ENCAMINHADO xsi:type="xsd:string"></CODIGO_OP_ENCAMINHADO> <IDMONITORIA xsi:type="xsd:string"></IDMONITORIA> <NOME_DO_ARQUIVO_MONITORIA xsi:type="xsd:string"></NOME_DO_ARQUIVO_MONITORIA> <DH_ARQUIVO_GERADO xsi:type="xsd:string"></DH_ARQUIVO_GERADO> <COD_STATUS xsi:type="xsd:string"></COD_STATUS> <CRMSIGLA_LOGRADOURO xsi:type="xsd:string"></CRMSIGLA_LOGRADOURO> <CODRELACIONAMENTO xsi:type="xsd:string"></CODRELACIONAMENTO> <CODCLIENTERELACIONADO xsi:type="xsd:string"></CODCLIENTERELACIONADO> <END_CLIENTE_COM xsi:type="xsd:string">Rod Navegantes</END_CLIENTE_COM> <BAIRRO_CLIENTE_COM xsi:type="xsd:string">Ilhas Claras</BAIRRO_CLIENTE_COM> <COMPLEMENTO_CLIENTE_COM xsi:type="xsd:string">Cj 171</COMPLEMENTO_CLIENTE_COM> <CEP_CLIENTE_COM xsi:type="xsd:string">01020000</CEP_CLIENTE_COM> <CIDADE_CLIENTE_COM xsi:type="xsd:string">São Paulo</CIDADE_CLIENTE_COM> <ESTADO_CLIENTE_COM xsi:type="xsd:string">SP</ESTADO_CLIENTE_COM> <NUM_END_CLIENTE_COM xsi:type="xsd:string">951</NUM_END_CLIENTE_COM> <DATA_TITULO xsi:type="xsd:string"></DATA_TITULO> <DATA_PAGAMENTO xsi:type="xsd:string"></DATA_PAGAMENTO> <IDCLIENTELIGACAO xsi:type="xsd:string"></IDCLIENTELIGACAO> <VALOR xsi:type="xsd:string"></VALOR> <AUTH_TOKEN xsi:type="xsd:string"></AUTH_TOKEN> <TIPO_RETORNO xsi:type="xsd:string"></TIPO_RETORNO> <ANEXOS xsi:type="xsd:string">[{"name":"pdf-test.pdf", "contentType":"application/pdf", "contentUrl": "https://www.orimi.com/pdf-test.pdf", "source":"emulator"}]</ANEXOS> <APENAS_PARA_CONTATOS xsi:type="xsd:string"></APENAS_PARA_CONTATOS> <IGNORE_CPF_CLIENTE_DUPLICADO xsi:type="xsd:string"></IGNORE_CPF_CLIENTE_DUPLICADO> <CODIGO_MIDIA xsi:type="xsd:string"></CODIGO_MIDIA> <IDCLIENTE xsi:type="xsd:string"></IDCLIENTE> <EMAIL_CLIENTE_2 xsi:type="xsd:string"></EMAIL_CLIENTE_2> <EMAIL_CLIENTE_3 xsi:type="xsd:string"></EMAIL_CLIENTE_3> <EMAIL_CONTATO xsi:type="xsd:string"></EMAIL_CONTATO> <DDI_RES_CLIENTE xsi:type="xsd:string"></DDI_RES_CLIENTE> <DDI_CEL_CLIENTE xsi:type="xsd:string"></DDI_CEL_CLIENTE> <DDI_COM_CLIENTE xsi:type="xsd:string"></DDI_COM_CLIENTE> <DDI_OUTROS_CLIENTE xsi:type="xsd:string"></DDI_OUTROS_CLIENTE> <DDI_RES2_CLIENTE xsi:type="xsd:string"></DDI_RES2_CLIENTE> <DDI_CEL2_CLIENTE xsi:type="xsd:string"></DDI_CEL2_CLIENTE> <DDI_COM2_CLIENTE xsi:type="xsd:string"></DDI_COM2_CLIENTE> <DDI_OUTROS2_CLIENTE xsi:type="xsd:string"></DDI_OUTROS2_CLIENTE> <DDI_RES3_CLIENTE xsi:type="xsd:string"></DDI_RES3_CLIENTE> <DDI_CEL3_CLIENTE xsi:type="xsd:string"></DDI_CEL3_CLIENTE> <DDI_COM3_CLIENTE xsi:type="xsd:string"></DDI_COM3_CLIENTE> <DDI_OUTROS3_CLIENTE xsi:type="xsd:string"></DDI_OUTROS3_CLIENTE> <DDI_RES4_CLIENTE xsi:type="xsd:string"></DDI_RES4_CLIENTE> <DDI_CEL4_CLIENTE xsi:type="xsd:string"></DDI_CEL4_CLIENTE> <DDI_COM4_CLIENTE xsi:type="xsd:string"></DDI_COM4_CLIENTE> <DDI_OUTROS4_CLIENTE xsi:type="xsd:string"></DDI_OUTROS4_CLIENTE> <DDI_TEL_RES_CLIENTE xsi:type="xsd:string"></DDI_TEL_RES_CLIENTE> <DDI_TEL_CEL_CLIENTE xsi:type="xsd:string"></DDI_TEL_CEL_CLIENTE> <DDI_TEL_COM_CLIENTE xsi:type="xsd:string"></DDI_TEL_COM_CLIENTE> <DDI_TEL_OUTROS_CLIENTE xsi:type="xsd:string"></DDI_TEL_OUTROS_CLIENTE> <DDI_TEL_RES2_CLIENTE xsi:type="xsd:string"></DDI_TEL_RES2_CLIENTE> <DDI_TEL_CEL2_CLIENTE xsi:type="xsd:string"></DDI_TEL_CEL2_CLIENTE> <DDI_TEL_COM2_CLIENTE xsi:type="xsd:string"></DDI_TEL_COM2_CLIENTE> <DDI_TEL_OUTROS2_CLIENTE xsi:type="xsd:string"></DDI_TEL_OUTROS2_CLIENTE> </urn:DadosServicedesk> </soapenv:Body> </soapenv:Envelope>
<SOAP-ENV:Envelope SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" 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:DadosServicedeskResponse xmlns:ns1="urn:server.Multidados"> <return xsi:type="xsd:string">{"success":true,"idocorrencia":8566,"$ret_save_oc":{"success":true,"error":"","idocorrencia":8566}}</return> </ns1:DadosServicedeskResponse> </SOAP-ENV:Body> </SOAP-ENV:Envelope>
Importante: O tipo de retorno desta api em particular pode ser configurada no sistema pelo caminho: CRM/Servicedesk>Parametrizações>Geral na aba Webservices.
Os Campos Adicionais de Ocorrência, Cliente ou Projeto podem ser enviados por esta API. Eles devem ser encaminhados como um tipo complexo, um vetor contendo os itens: código (código de identificação do campo adicional) e valor.
O valor do campo adicional deve ser encaminhado de acordo com seu tipo: campos de valor numérico ou textual devem ser encaminhados como STRING. Campos de lista de valores devem receber uma STRING contendo o código do valor correspondente.
Os anexos devem ser encaminhados em um JSON contendo:
Para utilizar os métodos de nosso webservice é necessário um usuário e senha cadastrados no sistema e a liberação dos IP que farão a comunicação com o serviço. Com isso eliminamos qualquer tipo de comunicação externa que não tenhamos conhecimento prévio. A Liberação dos IPs que utilizam os webservices é realizada pela Equipe Técnica da Multidados.
