Histórico da Página

Ativa/Inativa Cliente

(Obrigatório)

Informações Gerais

   Legenda: 1 – Inovação 2 – Manutenção (Os demais campos devem ser preenchidos para ambos os processos). 

(Obrigatório)

Objetivo

Disponibilizar uma API que possa ativar ou inativar cliente no TSS quando utilizado o Cloud.

(Obrigatório)

Definição da Regra de Negócio

Através da API de ativa ou inativa cliente, as aplicações cliente do TSS poderão liberar ou bloquear o cliente de transmitir documentos eletrônicos ao cloud. A atualização será realizada com base nos dados: CNPJ, CPF, Inscrição Estadual, UF, ativar ou inativar e o número do contrato. O critério para a atualização na base de dados será obtido através dos parâmetros recebidos pela API. A API terá como retorno um array contendo objetos, cada objeto representa uma entidade.

Na primeira ativação do cliente, será gerado um Token que será gravado na tabela TSS0005 para autenticação das mensagens entre o TSS Offline e TSS Cloud (Online). Este Token deverá também ser gravado na seção "[TSSOFFLINE]" do arquivo de configuração "APPSERVER" do TSS Offline, conforme exemplo abaixo:

[TSSOFFLINE]

TOKEN=50164fa93121e0d05843576147d0394c0a1b31ee

O consumo da API deverá ser realizado através O consumo da API deverá ser realizado através de mensagens JSON codificada em base64 definidas no WebService RestAtBlqEnt().

O processo de Serialização e Deserialização de mensagens deverá ser realizado através das funções FwJsonSerialize() e FwJsonDeserialize() respectivamente.

Os códigos de status serão baseados no formato padrão de mensagens HTTP, conforme o link:

https://pt.wikipedia.org/wiki/Lista_de_c%C3%B3digos_de_status_HTTP

WebService: RestAtBlqEnt()

WebService responsável pela definição da Interface da API de ativa ou inativa cliente.

O WebService deverá receber mensagens na estrutura JSON codificado em base64, onde serão decodificadas e passadas como parâmetro para a função AtBlqEnt().

Pode ser enviado mais de um cliente por requisição.

A chave para ativar ou inativar o cliente é:

Onde "Parametro" é do tipo numérico.

1 significa que o cliente será inativado.

2 significa que o cliente será ativado.

Portanto na linha de requisição abaixo, todas as entidades que contenham a chave CNPJ + CPF + IE + UF serão inativadas.

{"contrato":"12345","Empresas":[ {"tipopessoa":2,"cgccnpj":"5311379100012253113791001790","IE":"111010945111255721161","UF":"SPSC","Parametro":1}]},

No momento do retorno, será apresentado todas as entidades pertencentes a chave CNPJ + CPF + IE + UF, exemplo:

            {"CNPJ": "53113791000122","CPF": "","IE": "111010945111","UF": "SP","IDEMPRESA": "00000000000000000001","Entidade": "000002","OK": true,"mensagem": "Cliente bloqueado","error": "null"},

            {"CNPJ": "53113791000122","CPF": "","IE": "111010945111","UF": "SP","IDEMPRESA": "00000000000000000002","Entidade": "000121","OK": true,"mensagem": "Cliente bloqueado","error": "null"},

            { "CNPJ": "53113791000122","CPF": "","IE": "111010945111","UF": "SP","IDEMPRESA": "00000000000000000003","Entidade": "000122","OK": true,"mensagem": "Cliente bloqueado","error": "null"},

Quando a solicitação for bem-sucedida, o atributo "OK" virá com o conteúdo lógico True, mas caso não seja possível ativar ou inativar, o atributo virá com o conteúdo False.

O retorno do WebService será uma mensagem JSON contendo um array com objetos, cada objeto representa uma entidade.

Parâmetros: 

Mensagem JSON codificado em base 64.

JSON=

ew0KCSJFbXByZXNhcyI6DQoJCVsNCgkJCXsidGlwb3Blc3NvYSI6MiwiY2djIjoiNTMxMTM3OTEwMDAxMjIiLCJJRSI6IjExMTAxMDk0NTExMSIsIlVGIjoiU

1AiLCJQYXJhbWV0cm8iOjF9LA0KCQkJeyJ0aXBvcGVzc29hIjoyLCJjZ2MiOiIwMTE1OTQzNTAwMDE0NiIsIklFIjoiSVNFTlRPIiwiVUYiOiJQRSIsIlBhcmFtZ

XRybyI6Mn0sDQoJCQl7InRpcG9wZXNzb2EiOjIsImNnYyI6IjUzMTEzNzkxMDAwMTg1IiwiSUUiOiIwMDE0OTUxNzgwMDU0IiwiVUYiOiJNRyIsIlBhcmFtZX

RybyI6MX0NCgkJXQ0KfQ=eyJjb250cmF0byI6IjEyMzQ1IiwiRW1wcmVzYXMiOlsgeyJ0aXBvcGVzc29hIjoyLCJjbnBqIjoiNTMxMTM3OTEwMDE3OTAiLCJJRSI6IjI1NTcyMTE2MSIsIlVGIjoiU0MiLCJQYXJhbWV0cm8iOjF9XX0=

Mensagem JSON decodificada:

{

            {"contrato":"12345","Empresas":                        [                                     {"tipopessoa":2,"cgccnpj":"5311379100012253113791001790","IE":"111010945111255721161","UF":"SPSC","Parametro":1},

                                   {"tipopessoa":2,"cgc":"01159435000146","IE":"ISENTO","UF":"PE","Parametro":2},

                                    {"tipopessoa":2,"cgc":"53113791000185","IE":"0014951780054","UF":"MG","Parametro":1}

                        ]

}

Retorno Negativo:

{

   "result": [],

   "error": " Dados de entrada não podem ser processados: 'Empresas[3]:cgc'. "

}

Retorno Positivo:

{

]}

Retorno Negativo:

{

   "result": [],

   "error": " Dados de entrada não podem ser processados: 'Empresas[3]:cnpj'. "

}

Retorno Positivo:

{

   "result":    [

            {

         "CNPJ": "53113791000122",

         "CPF": "",

         "IE": "111010945111",

         "UF": "SP",

         "IDEMPRESA": "00000000000000000001",

         "Entidade": "000002",

         "OK": true,

         "mensagem": "Cliente bloqueado",

         "error": "null"

      },   "result":    [

            {

         "CNPJ": "53113791000122",

         "CPF": "",

         "IE": "111010945111",

         "UF": "SP",

         "IDEMPRESA": "0000000000000000000100000000000000000002",

         "Entidade": "000002000121",

         "OK": true,

         "mensagem": "Cliente bloqueado",

         "error": "null"

      },

            {

         "CNPJ": "53113791000122",

         "CPF": "",

         "IE": "111010945111",

         "UF": "SP",

         "IDEMPRESA": "0000000000000000000200000000000000000003",

         "Entidade": "000121000122",

         "OK": true,

         "mensagem": "Cliente bloqueado",

         "error": "null"

      },

            {

         "CNPJ": "5311379100012201159435000146",

         "CPF": "",

         "IE": "111010945111ISENTO",

         "UF": "SPPE",

         "IDEMPRESA": "00000000000000000003",

         "Entidade": "000122000003",

         "OK": true,

         "mensagem": "Cliente bloqueadoliberado",

         "error": "null"

      },

            {

         "CNPJ": "0115943500014653113790001285",

         "CPF": "",

         "IE": "ISENTO0014951780054",

         "UF": "PEMG",

         "IDEMPRESA": "",

         "Entidade": "000003",

         "OK": truefalse,

         "mensagem": "Cliente liberado"null,

         "error": "nullEntidade nao encontrada."

      }

   ],

            {

         "CNPJ   "error": "53113790001285",

         "CPF": "",

         "IE": "0014951780054",

         "UF": "MG",

         "IDEMPRESA": "",

         "Entidade": "",

         "OK": false,

         "mensagem": null,

         "error": "Entidade nao encontrada."

      }

   ],

   "error": null

}

Função: AtBlqEnt()

A função deverá receber mensagens na estrutura JSON, onde serão convertidas em objeto pela função fwJsonDeserialize().

Caso não haja erro na deserialização de JSON para objeto, será chamada a rotina ValEntrada(), passando como parâmetro o objeto.

A função ValEntrada() retornará uma matriz , onde cada linha do array será uma entidade diferente. Essa matriz será passada como parâmetro na chamada da função getJSONResp() junto com a mensagem de erro (caso exista). O retorno da função getJSONResp() é a mensagem  já na estrutura JSON.

A rotina ArBlqEnt() será finalizada e como retorno será passado a mensagem na estrutura JSON.

Parâmetros:

cJsonRequest =

{

            "Empresas":

                        [

null

}

Função: AtBlqEnt()

A função deverá receber mensagens na estrutura JSON, onde serão convertidas em objeto pela função fwJsonDeserialize().

Caso não haja erro na deserialização de JSON para objeto, será chamada a rotina ValEntrada(), passando como parâmetro o objeto.

A função ValEntrada() retornará uma matriz , onde cada linha do array será uma entidade diferente. Essa matriz será passada como parâmetro na chamada da função getJSONResp() junto com a mensagem de erro (caso exista). O retorno da função getJSONResp() é a mensagem  já na estrutura JSON.

A rotina ArBlqEnt() será finalizada e como retorno será passado a mensagem na estrutura JSON.

Parâmetros:

cJsonRequest =

{

            "contrato":"12345",

            "Empresas":

                        [

                                    {"tipopessoa":2,"cnpj":"53113791000122","IE":"111010945111","                                    {"tipopessoa":2,"cgc":"53113791000122","IE":"111010945111","UF":"SP","Parametro":1},

                                   {"tipopessoa":2,"cgccnpj":"01159435000146","IE":"ISENTO","UF":"PE","Parametro":2},

                                    {"tipopessoa":2,"cgccnpj":"53113791000185","IE":"0014951780054","UF":"MG","Parametro":1}

                        ]

}

Retorno Negativo:

{

   "result": [],

   "error": " Dados de entrada não podem ser processados: 'Empresas[3]:

cnpj'. "

}

Retorno Positivo:

{

   "result":    [

            {

         "CNPJ": "53113791000122",

         "CPF": "",

         "IE": "111010945111",

         "UF": "SP",

         "IDEMPRESA": "00000000000000000001",

         "Entidade": "000002",

         "OK": true,

         "mensagem": "Cliente bloqueado",

         "error": "null"

      },

            {

         "CNPJ": "53113791000122",

         "CPF": "",

         "IE": "111010945111",

         "UF": "SP",

         "IDEMPRESA": "00000000000000000002",

         "Entidade": "000121",

         "OK": true,

         "mensagem": "Cliente bloqueado",

         "error": "null"

      },

            {

         "CNPJ": "53113791000122",

         "CPF": "",

         "IE": "111010945111",

         "UF": "SP",

         "IDEMPRESA": "00000000000000000003",

         "Entidade": "000122",

         "OK": true,

         "mensagem": "Cliente bloqueado",

         "error": "null"

      },

            {

         "CNPJ": "01159435000146",

         "CPF": "",

         "IE": "ISENTO",

         "UF": "PE",

         "IDEMPRESA": "",

         "Entidade": "000003",

         "OK": true,

         "mensagem": "Cliente liberado",

         "error": "null"

      },

            {

         "CNPJ": "53113790001285",

         "CPF": "",

         "IE": "0014951780054",

         "UF": "MG",

         "IDEMPRESA": "",

         "Entidade": "",

         "OK": false,

         "mensagem": null,

         "error": "Entidade nao encontrada."

      }

   ],

   "error": null

}

Função:  ValEntrada()

A função receberá como parâmetro o objeto da requisição, validará todos os campos quanto a obrigatoriedade, tamanho e tipo de dados. Se algum dado estiver inconsistente, deverá retorna a mensagem de validação correspondente informando.

Os dados contidos no objeto recebido como parâmetro, serão validados afim de identificar quais foram preenchidos, os campos: TipoPessoa,

CNPJ, IE, UF, Parametro são obrigatórios.

Com as informações validadas, será chamada a função AtBlq(), para essa função serão passados como parâmetros: o CNPJ,CPF, IE, Uf e Parametro para a consulta no banco e atualização. O retorno desta função será uma matriz.

Após obter o retorno da rotina AtBlq, a função ValEntrada() será encerrada, retornando a matriz.

Parâmetros: 

oObjeto – Mensagem JSon deserializada e transformada em Objeto.

@cError – Mensagem de erro.

Retorno:

 aMatriz – matriz contendo os dados das entidades encontradas.

Função: AtBlq()

A rotina deverá executar o filtro na tabela SPED001 e retornando todas as entidades encontradas.

A rotina tentara atualizar o campo BLQCLI, o retorno sendo positivo ou não, será gerado um array temporário onde serão armazenados os dados daquele CNPJ ou CPF e as informações de sucesso ou não na atualização do campo.   

Parâmetros: 

cCNPJ – CNPJ do cliente.

cCPF  - CPF do cliente.

cIE – Inscrição estadual do cliente .

cUF – Unidade da Federação do cliente.

cParametro – parâmetro de controle, se 1 bloqueia cliente se 2 desbloqueia cliente.

Retorno:

aMatriz  -  Matriz multidimensional contendo objetos.

Função: GetJSONResp()

A rotina consiste em obter os dados de entrada e gerar a mensagem em estrutura JSON.

A rotina retornará uma string na estrutura JSON

Parâmetros: 

aArray– Array multidimensional.

cError – Mensagem de erro.

Retorno:

cJSONResponse – String na estrutura JSON.

Opcional

Protótipo de Tela

<Caso necessário inclua protótipos de telas com o objetivo de facilitar o entendimento do requisito, apresentar conceitos e funcionalidades do software>.

Protótipo 01

 Image Removed

Opcional

Fluxo do Processo

<Nesta etapa incluir representações gráficas que descrevam o problema a ser resolvido e o sistema a ser desenvolvido. Exemplo: Diagrama - Caso de Uso, Diagrama de Atividades, Diagrama de Classes, Diagrama de Entidade e Relacionamento e Diagrama de Sequência>. 

Opcional

Dicionário de Dados

Arquivo ou Código do Script: AAA – Negociação Financeira / *Versao=CP.2014.12_03*/

(Opcional)

Grupo de Perguntas

<Informações utilizadas na linha Protheus>.

Nome: FINSRF2

(Opcional)

Consulta Padrão

<Informações utilizadas na linha Protheus>

Consulta: AMB

campo.   

Parâmetros: 

cCNPJ – CNPJ do cliente.

cCPF  - CPF do cliente.

cIE – Inscrição estadual do cliente .

cUF – Unidade da Federação do cliente.

cParametro – parâmetro de controle, se 1 bloqueia cliente se 2 desbloqueia cliente.

Retorno:

aMatriz  -  Matriz multidimensional contendo objetos.

Função: GetJSONResp()

A rotina consiste em obter os dados de entrada e gerar a mensagem em estrutura JSON.

A rotina retornará uma string na estrutura JSON

Parâmetros: 

aArray– Array multidimensional.

cError – Mensagem de erro.

Retorno:

cJSONResponse – String na estrutura JSON.

(Opcional)

Estrutura de Menu

<Informações utilizadas na linha Datasul>.

Procedimentos

Programas

Cadastro de Papéis

<O cadastro de papéis é obrigatório para os projetos de desenvolvimento FLEX a partir do Datasul 10>.

<Lembrete: o nome dos papeis em inglês descrito neste ponto do documento, devem ser homologados pela equipe de tradução>.