Documentação AzixWS2 2.3

AZIX WS (WEB SERVICE)
AzixWS2 Versão 2.3
1. Informações Gerais do Serviço.
1.1 Contexto
O serviço WebService AzixWS2 foi desenvolvido com um propósito específico para atendimento a determinada
necessidade pontual. Este tutorial se propõe a dar uma visão geral sobre o funcionamento.
1.2 Autenticação
O serviço de consulta requer autenticação por parte do “Usuário”, essa autenticação é única para cada Usuário.
Toda consulta invocada pelo Usuário é registrada em uma tabela de auditoria, mesmo que a operação seja
executada com sucesso ou não, registrando assim, “quem”, “quando”, “onde e o quê” foi realizado durante o serviço
invocado.
1.3 Objetivo
O AzixWS2 tem como principal característica a consulta e o retorno das informações, de acordo com as
solicitações e regras pré-estabelecidas.
1.4 Endereço para Consulta
Ambiente de Homologação:
Método para Consulta:
Endereço WSDL:
1.5 Área Técnica

Suporte: [email protected]
Telefone: +55 (11) 2495-4618 2495-4692
2. Usuário e Senha de Acessos para Homologação.

Usuário e Senha somente liberados via solicitação de e-mail.
Usuário (usuario) Senha (token)

Dados enviados por e-mail.
3. Listas de Serviços Disponíveis:
Identificador do Serviço Descrição

16 Receita Federal Pessoa Jurídica (CNPJ) - Base
4. Informações Detalhadas do Serviço
4.1 Parâmetros de Entrada para Consulta

Consulta (string usuario, string token, string codigoServico, string parametro1, string parametro2, string
parametro3, string parametro4, string parametro5, string TamRazaoSocial, string TamNomeFantasia, string
TamLogradouro, string TamComplemento, string TamBairro, string TamMunicipio)
Entrada Descrição
usuario E-mail do usuário.
token Senha do Usuário.
codigoServico Código do Serviço.
parametro1 Parâmetro 1 utilizado nas consultas.
TamRazaoSocial Tamanho da Razão Social para Abreviação e eliminação de caracteres especiais.
TamNomeFantasia Tamanho do Nome Fantasia para Abreviação e eliminação de caracteres especiais.
TamLogradouro Tamanho do Logradouro para Abreviação e eliminação de caracteres especiais.
TamComplemento Tamanho do Complemento para Abreviação e eliminação de caracteres especiais.
TamBairro Tamanho do Bairro para Abreviação e eliminação de caracteres especiais.
TamMunicipio Tamanho do Município para Abreviação e eliminação de caracteres especiais.
4.1.1 Entrada: usuario.

Este campo é obrigatório, corresponde ao login do Usuário (Ver Item 2).
4.1.2 Entrada: token.

Este campo é obrigatório, corresponde ao token para acesso (Ver Item 2).
4.1.3 Entrada: codigoServico.

Este campo é obrigatório, corresponde ao Identificador do Serviço a ser consultado (Ver Item 3).
4.1.4 Entrada: parametro1.

Este campo é obrigatório conterá os dados necessário para consulta de cada Serviço.

Este campo não é obrigatório inicialmente, dependendo o serviço a ser consulta o campo passa a ser
utilizado.

utilizado.

utilizado.

utilizado.
4.1.9 Entrada: TamRazaoSocial.

Este campo não é obrigatório, caso deseje realizar abreviação na Razão Social deve preencher o campo com
o tamanho desejado. Dependendo do Serviço a opção é válida ou não.
4.1.10 Entrada: TamNomeFantasia.

Este campo não é obrigatório, caso deseje realizar abreviação no Nome Fantasia deve preencher o campo
com o tamanho desejado. Dependendo do Serviço a opção é válida ou não.
4.1.11 Entrada: TamLogradouro.

Este campo não é obrigatório, caso deseje realizar abreviação no Logradouro deve preencher o campo com
o tamanho desejado. Dependendo do Serviço a opção é válida ou não.
4.1.12 Entrada: TamComplemento.

Este campo não é obrigatório, caso deseje realizar abreviação no Complemento deve preencher o campo
com o tamanho desejado. Dependendo do Serviço a opção é válida ou não.
4.1.13 Entrada: TamBairro.
Este campo não é obrigatório, caso deseje realizar abreviação no Bairro deve preencher o campo com o
tamanho desejado. Dependendo do Serviço a opção é válida ou não.
4.1.14 Entrada: TamMunicipio.

Este campo não é obrigatório, caso deseje realizar abreviação no Município deve preencher o campo com o
tamanho desejado. Dependendo do Serviço a opção é válida ou não.
5. Estrutura XML
O XML de retorno é comporto por três partes:
5.1 Retorno Consulta <RetornoConsulta>

Estrutura Inicial que compõem o XML como um todo:
<RetornoConsulta Versão="1.0" Quantidade="0">

...............
...............
...............
</RetornoConsulta>
Tabela de Atributos
Versão Corresponde a versão publicada.
Quantidade Quantos registros a consulta retornou.
5.2 Parametros Consulta <ParametrosConsulta>

Estrutura que contém os dados utilizados para realização da consulta:

<ParametrosConsulta>
<CodigoServico>1</CodigoServico>
<Parametro1>5453545345345</Parametro1>
<Parametro2>BA</Parametro2>
<Parametro3/>
<Parametro4/>
<Parametro5/>
</ParametrosConsulta>
................
................
</RetornoConsulta>
5.3 Dados Consulta <DadosConsulta>

Estrutura que contém os dados do status da consulta, o entendimento completo do retorno.

................
<DadosConsulta>
<Codigo>000</Codigo>
<Mensagem>Êxito</Mensagem>
</DadosConsulta>
................
</RetornoConsulta>
5.4 Dados Retorno <DadosRetorno>

Estrutura contém os dados extraídos do documento. Esta sempre contém a TAG <Documento>, que corresponde
ao link para acessar o documento da consulta.

................
................
<DadosRetorno Id="0">
<NumeroInscricao>20857131000105</NumeroInscricao>
<TipoEmpresa>MATRIZ</TipoEmpresa>
<DataAbertura>18/08/2014</DataAbertura>
<NomeEmpresarial>BLUE GROUP PARTICIPACOES LTDA</NomeEmpresarial>
...............
<Documento>http://app2.azix.com.br/Documentos/..........html</Documento>
</DadosRetorno>
</RetornoConsulta>
Tabela de Atributos
Id Corresponde a quantidade de registros retornados, começa sempre em 0, e assim sucessivamente, 0, 1, 2,
3 e etc.
Cobrança Código Mensagem
SIM 000 Êxito
NÃO 001 Usuário inválido para consulta.
NÃO 002 Token inválido para consulta.
NÃO 003 Usuário/Token inválidos para autenticação.
NÃO 004 Usuário sem saldo para realizar consultas.
SIM 005 Serviço inválido para consulta.
SIM 006 Usuário não licenciado para consulta no serviço.
NÃO 007 Serviço indisponível para consulta.
NÃO 008 Erro Durante a Consulta. Tente novamente.
NÃO 009 Quantidade de tentativas excedidas. Tente novamente.
SIM 010 Parâmetro inválido para consulta.
SIM 011 Dados não encontrados na fonte consultada.
SIM 012 Os parâmetros foram recusados pela fonte consultada.
SIM 013 Os dados estão incompletos na fonte consultada.
Parâmetro enviado sofreu alterações. Suspenda o uso e entre em contato com
SIM 014 [email protected].
A fonte de dados emitiu um erro. Suspenda o uso e entre em contato com
SIM 015 [email protected].
SIM 016 UF (Unidade Federativa) inválida para consulta.
SIM 017 Data de nascimento informada está divergente na RFPF.
SIM 018 Sintegra RS retornou mais de uma IE (Inscrição Estadual).
6. Códigos de Retorno – Validações.

7. Consulta – Receita Federal Pessoa Jurídica (CNPJ) - Base
Campos em verde na tabela correspondem a opção de abreviação e utilização.
Entrada Situação Descrição

usuario Obrigatório Usuário (Login de acesso)
token Obrigatório Token (senha)
codigoServico Obrigatório 16
parametro1 Obrigatório CNPJ sem pontos e sem traço, exemplo: 034546370001345
parametro2 Não utiliza
TamRazaoSocial Não obrigatório Tamanho da Abreviação Razão social, exemplo: 10
TamNomeFantasia Não obrigatório Tamanho da Abreviação Nome Fantasia, exemplo: 10
TamLogradouro Não obrigatório Tamanho da Abreviação Logradouro, exemplo: 10
TamComplemento Não obrigatório Tamanho da Abreviação Complemento, exemplo: 10
TamBairro Não obrigatório Tamanho da Abreviação Bairro, exemplo: 10
TamMunicipio Não obrigatório Tamanho da Abreviação Município, exemplo: 10
Modelo de retorno em anexo: Consulta 16 - Modelo Retorno.xml

Documentação AzixWS2 2.3

Enviado por

Direitos autorais:

Formatos disponíveis

Documentação AzixWS2 2.3

Enviado por

Dados do documento

Título original

Direitos autorais

Formatos disponíveis

Compartilhar este documento

Compartilhar ou incorporar documento

Opções de compartilhamento

Você considera este documento útil?

Este conteúdo é inapropriado?

Direitos autorais:

Formatos disponíveis

Documentação AzixWS2 2.3

Enviado por

Direitos autorais:

Formatos disponíveis

AZIX WS (WEB SERVICE)

AzixWS2 Versão 2.3

1. Informações Gerais do Serviço.

1.4 Endereço para Consulta

1.5 Área Técnica

2. Usuário e Senha de Acessos para Homologação.

Usuário (usuario) Senha (token)

3. Listas de Serviços Disponíveis:

Identificador do Serviço Descrição

4. Informações Detalhadas do Serviço

4.1 Parâmetros de Entrada para Consulta

4.1.1 Entrada: usuario.

4.1.2 Entrada: token.

4.1.3 Entrada: codigoServico.

4.1.4 Entrada: parametro1.

4.1.5 Entrada: parametro2.

4.1.6 Entrada: parametro3.

4.1.7 Entrada: parametro4.

4.1.8 Entrada: parametro5.

4.1.9 Entrada: TamRazaoSocial.

4.1.10 Entrada: TamNomeFantasia.

4.1.11 Entrada: TamLogradouro.

4.1.12 Entrada: TamComplemento.

4.1.14 Entrada: TamMunicipio.

O XML de retorno é comporto por três partes:

5.1 Retorno Consulta <RetornoConsulta>

<RetornoConsulta Versão="1.0" Quantidade="0">

5.2 Parametros Consulta <ParametrosConsulta>

<RetornoConsulta Versão="1.0" Quantidade="0">

5.3 Dados Consulta <DadosConsulta>

<RetornoConsulta Versão="1.0" Quantidade="0">

5.4 Dados Retorno <DadosRetorno>

<RetornoConsulta Versão="1.0" Quantidade="0">

6. Códigos de Retorno – Validações.

Entrada Situação Descrição

Modelo de retorno em anexo: Consulta 16 - Modelo Retorno.xml

Você também pode gostar