Com o serviço web SOAP (Simple Object Access Protocol) é possível realizar o cadastro, listagem e edição de contato sem a necessidade de estar no sistema. Este recurso é utilizado para fazer integração e/ou automatização de processos de qualquer sistema com o Procedo.

Nome: contatoservice

Tecnologia: Webservice SOAP

URL WSDL: https://app.procedo.com.br/api/contatoservice?wsdl

Objetivo: Webservice que realiza operações vinculadas ao contato.

Métodos

Método: listaContato

Descrição: método responsável por retornar uma lista de contatos do Procedo.

Parâmetro  Obrigatório Formato Descrição
token sim String Identificado único da empresa para uso do método.
situação não String Nome das situações separadas por virgula. Por padrão retorna todas as situações
fase não String Nome da fase. Por padrão retorna os contatos na fase “Cliente”
cod_contato não Int Use esse campo caso queira encontrar um contato específico

Retorno

A tabela abaixo indica os possíveis retornos de erros ou confirmação para o método listaContato.

Código Retorno
0 Token inválido, neste caso é necessário entrar em contato novamente para obter o código de acesso
1 Ok
2 Situação não encontrada
9 Nenhum registro encontrado
35 Empresa sem acesso a funcionalidade solicitada

Exemplo

Exemplo de requisição para obter um contato com as informações sendo enviadas através do SoapUI:

<x:Envelope xmlns:x="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:SOAPServerWSDL">
    <x:Header/>
    <x:Body>
        <urn:listaContato>
            <urn:token>1fttwef1de774efa005f8da13f5642943881c655fQe5wqA</urn:token>
            <urn:situacao>Contatado, Novo</urn:situacao>
            <urn:fase>Prospect</urn:fase>
            <urn:cod_contato></urn:cod_contato>
        </urn:listaContato>
    </x:Body>
</x:Envelope>

Caso o contato seja uma pessoa e não uma empresa, então o campo CNPJ retornará o CPF e o campo inscricao_estadual conterá o RG.

Outra observação importante é que há um limite de retorno de 50 contatos.

Método: gravaCodContato

Descrição: método responsável por atualizar um contato no Procedo após integrá-lo com um sistema. Esse método fará com que o registro do contato no Procedo não seja integrado novamente pelo método listaContato.

Parâmetro  Obrigatório Formato Descrição
token sim String Identificado único da empresa para uso do método
codigo_procedo
sim Int Código do contato no Procedo
codigo_externo
sim Int Código do contato no sistema onde o mesmo foi integrado
mensagem não String Informa ao sistema Procedo que não foi possível gravar no sistema externo o contato correspondente
cnpj não String Para pessoa Física, informe o CPF e, para Jurídica, o CNPJ. Esse campo é utilizado como uma segunda chave para validar o contato

O campo “mensagem” só deverá ser preenchido caso ocorra algum erro.

Ao inserir o “codigo_externo” diferente do “codigo_procedo” e mais o “cnpj”, o Procedo irá atualizar o “codigo_procedo” para o código que estiver vindo pelo parâmetro “codigo_externo”. 

Retorno

Código Retorno
0 Token inválido, neste caso é necessário entrar em contato novamente para obter o código de acesso
1 Ok, o registro foi inserido ou atualizado
9 Contato não encontrado no Procedo
35 Empresa sem acesso a funcionalidade solicitada
99 Erro ao atualizar o contato

Exemplo

<x:Envelope xmlns:x="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:SOAPServerWSDL">
    <x:Header/>
    <x:Body>
        <urn:gravaCodContato>
            <urn:token>1fttwef1de774efa005f8da13f5642943881c655fQe5wqA</urn:token>
            <urn:codigo_procedo>900</urn:codigo_procedo>
            <urn:codigo_erp>100</urn:codigo_erp>
            <urn:nome_abreviado>Exemplo API</urn:nome_abreviado>
            <urn:mensagem></urn:mensagem>
            <urn:cnpj>66.333.716/4531-28</urn:cnpj>
        </urn:gravaCodContato>
    </x:Body>
</x:Envelope>

Método: gravaContato

Descrição: Método responsável por inserir um contato.

Parâmetro  Obrigatório Formato Descrição
token sim String Identificado único da empresa para uso do método
codigo_externo não Int Informe o código que será atribuído a este contato. Caso o código informado já esteja cadastrado no Procedo, será feito uma atualização dos dados e não um novo registro, por isso é recomendado que deixe esse campo em branco
tipo_pessoa não String Escolha entre “Empresa” e “Pessoa” Se esse campo ficar em branco será registrado o contato como “Pessoa”
fase não String Nome da fase, escolha entre, cliente, prospect, suspect, lead
nome_fantasia parcialmente String Se for “Empresa” então esse campo é obrigatório
razao_social parcialmente String Se for “Pessoa” então esse campo é obrigatório
ramoatividade não String Nome do Ramo de Atividade cadastrado no sistema
telefone1 não String Telefone 1
telefone2 não String Telefone 2 adicional
origem não String Nome da origem cadastrada no Procedo
usuario sim  Int E-mail do usuário responsável pelo Contato
cnpj não String Para “Pessoa” informe o CPF, e para Jurídica o CNPJ
ie não String Inscrição estadual. Para “Pessoa”, informe o RG e, para Jurídica, o I.E. Caso este campo fique em branco, será cadastrado como isento (testar somente números)
website não String Site do contato
cargo não String Cargo da Pessoa
email não String Email da Pessoa
cidade não String Cidade do endereço principal
estado não String Estado do endereço principal. Deve ser escrito no formato de sigla, exemplo: SP, RJ, BA
logradouro não String Logradouro do endereço principal
numero não String Número do endereço principal
complemento não String Complemento do endereço principal
cep não String CEP do endereço principal
bairro não String Bairro do endereço principal
referencia não String Referência do endereço principal
cidade_cobranca não String Cidade do endereço de cobrança
estado_cobranca não String Estado do endereço de cobrança. Deve ser escrito no formato de sigla, exemplo: SP, RJ, BA
logradouro_cobranca não String Logradouro do endereço de cobrança
numero_cobranca não String Número do endereço de cobrança
complemento_cobranca não String Complemento do endereço de cobrança
cep_cobranca não String CEP do endereço de cobrança
bairro_cobranca não String Bairro do endereço de cobrança
referencia_cobranca não String Referência do endereço de cobrança
regiao não String Nome da Região cadastrado no sistema
grupo_cliente não String Nome do Grupo de Contato cadastrado no sistema
dt_abertura não String Data de abertura da empresa
email_financeiro não String E-mail de contato financeiro
email_nfe não String E-mail da nota fiscal eletrônica
atividade_economica não String Descrição da Atividade econômica
obs não String Observação referente ao contato
nome_contato não String Nome do contato na empresa. Para cadastrar o contato, o nome é obrigatório, ou seja, os dados sobre o contato serão ignorados caso esse campo não esteja preenchido
email_contato não String E-mail do contato
telefone1_contato não String Telefone 1 do contato
telefone2_contato não String Telefone 2 do contato
celular_contato não String Celular do contato
skype_contato não String Skype do contato
cargo_contato não String Cargo do contato
email_contato não String Email do contato

Para informar um endereço de cobrança, deve ser, no mínimo, preenchido “cidade_cobranca” e “estado_cobranca”, caso não estes campos não estejam preenchido, o sistema considerará o endereço principal como endereço de cobrança.

Nos campos “ramoatividade”, “origem”, “regiao” e “grupo_cliente”, deverá ser preenchido com o nome e, caso não seja localizado, o cadastro será realizado. Vale ressaltar que o sistema não faz diferença entre acentos e caracteres maiúsculo e minúsculo, ou seja, “MÍDIA” é igual a “midia”.

Retorno

Código Retorno
0 Token inválido, neste caso é necessário entrar em contato novamente para obter o código de acesso
1 Ok, o registro foi inserido
2 E-mail do usuário não encontrado no Procedo
3 Campo obrigatório em branco. Campos obrigatórios: nome_fantasia, razao_social
9 CNPJ duplicado ou ocorreu um problema durante a gravação. Verifique se as informações, ou se os campos obrigatórios estão preenchidos
35 Empresa sem acesso a funcionalidade solicitada

 

Deixe uma resposta

O seu endereço de e-mail não será publicado. Campos obrigatórios são marcados com *