Para permitir que o TOTVS | HTML Framework acesse os dados do ERP Datasul, foram construidos serviços REST para facilitar o acesso de API's e DBO's a partir do javascript. A API utp/utapi035 foi desenvolvida para consumo dos serviços da API de Mashup, retornando os dados em formato JSON.

Serviços

Os serviços da API REST Mashup estão adequados para utilização no TOVS HTML Framework.

Consulta de CNPJ

Para utilização do serviço de consulta de CNPJ, devem ser executados dois serviços: o primeiro para retorno da imagem de verificação e o segundo para retorno dos dados.

Para retorno da imagem de verificação, deve ser executado o serviço "getConsultaCNPJCaptcha", de acordo com o seguinte padrão:

http://servidor:porta/dts/datasul-rest/resources/api/utp/utapi035/getConsultaCNPJCaptcha

Este serviço retornará dois dados:

• Captcha: imagem de verificação no formato base64;
• ServiceExecutionId: ID de execução do serviço - este ID deverá ser enviado na segunda parte do serviço.

Para obter os dados do CNPJ desejado, deve ser executado o serviço "getCNPJ", de acordo com o padrão abaixo:

http://servidor:porta/dts/datasul-rest/resources/api/utp/utapi035/getCNPJ?CNPJ={CNPJ}&Codigo={Codigo}&ServiceExecutionId={ServiceExecutionId}

• CNPJ: CNPJ para o qual deve ser efetuada a consulta;
• Codigo: Código digitado para a imagem de verificação;
• ServiceExecutionId: ID de execução do serviço (retornado do serviço "getConsultaCNPJCaptcha").

O serviço retornará os dados em um JSONArray contendo um objeto com os seguintes dados:

• CNPJ;

• DataAbertura;

• RazaoSocial;

• NomeFantasia;

• AtividadePrincipal;

• NaturezaJuridica;

• Endereco;

• Numero;

• Complemento;

• CEP;

• Bairro;

• Cidade;

• Estado;

• SituacaoCadastral;

• DataSituacaoCadastral;

• MotivoSituacaoCadastral;

• SituacaoEspecial;

• DataSituacaoEspecial.

Consulta de CPF 

Para utilização do serviço de consulta de CPF, devem ser executados dois serviços: o primeiro para retorno da imagem de verificação e o segundo para retorno dos dados.

Para retorno da imagem de verificação, deve ser executado o serviço "getConsultaCPFCaptcha", de acordo com o seguinte padrão:

http://servidor:porta/dts/datasul-rest/resources/api/utp/utapi035/getConsultaCPFCaptcha

Este serviço retornará dois dados:

• Captcha: imagem de verificação no formato base64;
• ServiceExecutionId: ID de execução do serviço - este ID deverá ser enviado na segunda parte do serviço.

Para obter os dados do CFPF desejado, deve ser executado o serviço "getCPF", de acordo com o padrão abaixo:

http://servidor:porta/dts/datasul-rest/resources/api/utp/utapi035/getCPF?CPF={CPF}&DataNasc={DataNasc}&Codigo={Codigo}&ServiceExecutionId={ServiceExecutionId}

• CPF: CPF para o qual deve ser efetuada a consulta;
• DataNasc: Data de nascimento da pessoa ao qual o CPF pertence;
• Codigo: Código digitado para a imagem de verificação;
• ServiceExecutionId: ID de execução do serviço (retornado do serviço "getConsultaCPFCaptcha")

O serviço retornará os dados em um JSONArray contendo um objeto com os seguintes dados:

• CPF;

• Nome;

• Situacao;

• DigitoVerificador;

• DataNascimento.

Consulta de estados

Para consulta de estados, deve ser executado o serviço no seguinte padrão:

http://servidor:porta/dts/datasul-rest/resources/api/utp/utapi035/getEstados

Este serviço retornara um objeto JSONArray contendo objetos com as seguintes propriedades:

• Code: UF;
• Description: nome do estado.

SINTEGRA

Para utilização do serviço do SINTEGRA, deve ser executado o serviço no seguinte padrão:

http://servidor:porta/dts/datasul-rest/resources/api/utp/utapi035/sintegraParcial?CNPJ={CNPJ}&Estado={Estado}

• CNPJ: CNPJ para consulta;
• Estado: UF do estado no qual o CNPJ está cadastrado.

Este serviço retornará os seguintes dados:

• Captcha: imagem de verificação no formato base64;
• ServiceExecutionId: ID de execução do serviço - este ID deverá ser enviado na segunda parte do serviço;
• ttInscricoes: JSONArray contendo as inscrições do CNPJ para seleção;
• ttSintegra: JSONArray contendo os dados do CNPJ informado.

Os valores retornados variam de acordo com o estado, podendo não ter a imagem ou a lista de inscrições. Para executar o serviço seguinte, deve ser verificada a existência de valor no objeto retornado.

Envio de código de imagem de verificação

Caso o objeto retornado possua uma imagem para validação, esta deve ser validada para a execução do próximo serviço, seguindo o padrão a seguir:

http://servidor:porta/dts/datasul-rest/resources/api/utp/utapi035/sintegraContinuacaoCaptcha?Codigo={Codigo}&ServiceExecutionId={ServiceExecutionId}

• Codigo: Código digitado para a imagem de verificação;
• ServiceExecutionId: ID de execução do serviço (retornado do serviço "sintegraParcial").

Este serviço retornará os seguintes dados:

• ttInscricoes: JSONArray contendo as inscrições do CNPJ para seleção;
• ttSintegra: JSONArray contendo os dados do CNPJ informado.

Os valores retornados variam de acordo com o estado, podendo não ter a lista de inscrições. Para executar o serviço seguinte, deve ser verificada a existência de valor no objeto retornado.

Envio de código da inscrição selecionada

Caso o objeto retornado possua dados na lista de inscrições estaduais, estes devem ser apresentados para seleção, de forma que a inscrição enviada seja enviada no próximo serviço, seguindo o padrão a seguir:

http://servidor:porta/dts/datasul-rest/resources/api/utp/utapi035/sintegraContinuacaoInscricao?Inscricao={Inscricao}&ServiceExecutionId={ServiceExecutionID}

• Inscricao: código da inscrição selecionada (deve ser enviado o valor "Inscricao" do objeto JSON contendo a inscrição selecionada);
• ServiceExecutionId: ID de execução do serviço (retornado no serviço "sintegraParcial").

O serviço retornará os dados em um JSONArray contendo um objeto com os seguintes dados:

• CNPJ;

• Inscricao;

• Razao;

• Logradouro;

• Numero;

• Complemento;

• Bairro;

• Cidade;

• Estado;

• CEP;

• Telefone;

• EMail;

• DataInscricao;

• Situacao;

• DataSituacao;

• Atividade;

• RegimeICMS;

• Observacoes;

• AtividadePrincipal.

SUFRAMA

Para utilização do serviço do SUFRAMA, devem ser executados três serviços:

1. retorno da imagem de verificação;
2. retorno de segunda imagem de verificação e de lista de inscrições;
3. retorno de dados.

Para retorno da imagem de verificação, deve ser executado o serviço "suframaGetCaptcha", de acordo com o seguinte padrão:

http://servidor:porta/dts/datasul-rest/resources/api/utp/utapi035/suframaGetCaptcha

Este serviço retornará dois dados:

• Captcha: imagem de verificação no formato base64;
• ServiceExecutionId: ID de execução do serviço - este ID deverá ser enviado na segunda parte do serviço.

A seguir, deve ser executado o serviço para retorno da segunda imagem de verificação e de lista de inscrições, seguindo o seguinte padrão:

http://servidor:porta/dts/datasul-rest/resources/api/utp/utapi035/suframaGetInscricoes?ServiceExecutionId={ServiceExecutionId}&CNPJ={CNPJ}&Codigo={Codigo}

• ServiceExecutionId: ID de execução do serviço (retornado do serviço "suframaGetCaptcha");
• CNPJ: CNPJ para o qual será feita a consulta;
• Codigo: código digitado para a imagem retornada no serviço "suframaGetCaptcha".

Este serviço retornará um objeto contendo os seguintes dados:

• Captcha: imagem de verificação em formato base64;
• ttInscricoes: JSONArray contendo as inscrições do CNPJ para seleção.

Para retorno dos dados, deverá ser executado o serviço seguindo o padrão:

http://servidor:porta/dts/datasul-rest/resources/api/utp/utapi035/suframaGetDados?ServiceExecutionId={ServiceExecutionId}&Codigo={Codigo}&Inscricao={Inscricao}

• ServiceExecutionId: ID de execução do serviço (retornado do serviço "suframaGetCaptcha");
• Codigo: código digitado para a imagem retornada no serviço "suframaGetInscricoes";
• Inscricao: código da inscrição selecionada (deve ser enviado o valor "Inscricao" do objeto JSON contendo a inscrição selecionada).

O objeto retornará os dados em um objeto JSONArray contendo um objeto com os seguintes dados:

• CNPJ;

• InscricaoSuframa;

• RazaoSocial;

• Endereco;

• Complemento;

• Bairro;

• Cidade;

• Estado;

• CEP;

• EMail;

• Telefone;

• AtividadePrincipal;

• AtividadeSecundaria

• AtividadeEstadual;

• TipoIncentivos;

• SituacaoCadastral.

Consulta de motoristas

A consulta de motoristas pode ser executada seguindo o seguinte padrão:

http://servidor:porta/dts/datasul-rest/resources/api/utp/utapi035/getMotoristas?CPF={CPF}&Prontuario={Prontuario}&CNPJ={CNPJ}&NomeMotorista={NomeMotorista}

• CPF: CPF do motorista;
• Prontuario: prontuário do motorista;
• CNPJ: CNPJ da empresa;
• NomeMotorista: nome do motorista.

Os parâmetros são todos opcionais, mas ao menos um deve ser informado para que haja retorno de dados.

O serviço retornará um JSONArray contendo objetos com as seguintes propriedades:

• Nome;

• CPF;

• Prontuario;

• Empresa;

• Admissao;

• Demissao;

• AntecedenteEstadual;

• AntecedenteFederal;

• DescStatus.

Classificação Brasileira de Ocupações

A consulta de ocupações pode ser feita de duas maneiras: código da ocupação ou descrição da ocupação.

A consulta pode ser executada seguindo o seguinte padrão:

http://servidor:porta/dts/datasul-rest/resources/api/utp/utapi035/getCBOList?Pesquisa={Pesquisa}&Texto={Texto}

• Pesquisa: indica se a pesquisa será feita por código ou descrição. Pode receber os valores "c" (código) ou "d" (descrição);
• Texto: código ou descrição da ocupação pesquisada.

O serviço retornará um JSONArray contendo objetos com as seguintes propriedades:

• Titulo;
• Codigo;
• Tipo.

Consulta de municípios - NFSE

A consulta de municípios pode ser executada seguindo o seguinte padrão:

http://servidor:porta/dts/datasul-rest/resources/api/utp/utapi035/consultaMunicipiosNFSE

O serviço retornará um JSONArray contendo objetos com as seguintes propriedades:

• CodMunicipio;

• CodeTD;

• Layout;

• PodeEnviar;

• PodeConsultar;

• PodeCancelar;

• PodeSubstituir;

• PodeValidarSchema;

• GeraCNAE.

Busca de moedas

A busca de moedas pode ser executada seguindo o seguinte padrão:

http://servidor:porta/dts/datasul-rest/resources/api/utp/utapi035/getConversionCoinList

O serviço retornará um JSONArray contendo objetos com as seguintes propriedades:

• Descricao;
• Codigo.

Conversão de moedas

A consulta de moedas pode ser executada seguindo o seguinte padrão:

http://servidor:porta/dts/datasul-rest/resources/api/utp/utapi035/conversaoMoeda?MoedaOrigem={MoedaOrigem}&MoedaDestino={MoedaDestino}&Valor={Valor}&Data={Data}

• MoedaOrigem: código da moeda que será convertido o valor;
• MoedaDestino: código da moeda para a qual será convertido o valor;
• Valor: valor a ser convertido;
• Data: data para base da conversão da moeda.

O serviço retornará um JSONArray contendo um objeto com as seguintes propriedades:

• Data;

• Taxa;

• ValorDestino;

• MoedaOrigem;

• ValorOrigem;

• MoedaDestino.

Pesquisa de CEP

A consulta de CEP pode ser executada seguindo o seguinte padrão:

http://servidor:porta/dts/datasul-rest/resources/api/utp/utapi035/correiosPesquisaCEP?CEP={CEP}

• CEP: CEP para o qual será pesquisado o endereço.

O serviço retornará um JSONArray contendo um objeto com as seguintes propriedades:

• CEP;

• Endereco;

• Bairro;

• Cidade;

• Estado.

Busca de idiomas

A busca de idiomas pode ser executada seguindo o seguinte padrão:

http://servidor:porta/dts/datasul-rest/resources/api/utp/utapi035/getIdiomas

O serviço retornará um JSONArray contendo objetos com as seguintes propriedades:

• Code;
• Description.

Tradução

A tradução pode ser executada seguindo o seguinte padrão:

http://servidor:porta/dts/datasul-rest/resources/api/utp/utapi035/googleTranslate?Texto={Texto}&Origem={Origem}&Destino={Destino}

• Texto: texto a ser traduzido;
• Origem: código do idioma do qual o texzto será traduzido;
  
• Destino: código do idioma para o qual o idioma será traduzido.

O serviço retornará um JSONArray contendo objetos com as seguintes propriedades:

• Data;

• Taxa;

• ValorDestino;

• MoedaOrigem;

• ValorOrigem;

• MoedaDestino.

Fontes

$/FOUNDATION/Fontes_Doc/Sustentacao/V11/V11/progress/src/utp/

• utapi035.i
• utapi035.p