Histórico da Página

(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 para Bilhetagem do TSS.

(Obrigatório)

Definição da Regra de Negócio

Através da API de bilhetagem do TSS, as aplicações cliente do TSS poderão obter informações sobre a quantidade de documentos que foram para a fila do TSS online. A consulta será realizada por CNPJ ou CPF, inscrição estadual, estado e tipo de pessoa, como os parâmetros mês e ano. O critério para consulta na base de dados será obtido através dos parâmetros recebidos pela API. A API terá como retorno os somatórios das quantidades dos documentos encontrados de todos os CNPJs passado na requisição, separado por ambiente de produção e homologação SEFAZ.

O consumo da API deverá ser realizado através de mensagens JSON em base 64 definidas no serviço REST TSSRESTBILLING().

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

As informações obrigatórias para o consumo da API são CNPJ ou CPF, inscrição estadual, estado e tipo de pessoa, como os parâmetros mês e ano 

WebService: TSSRESTBILLING()

Serviço REST responsável pela definição da Interface da API de Bilhetagem TSS.

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

Parâmetros: 

JSON = ew0KICAgICAgICAgICAgIkVNUFJFU0EiOiBbew0KICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAiQ0dDIjogIjA3NTQ5NzA3MDAwMTA5IiwNCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIklOU0MiOiAiMTIxIiwNCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIlVGIjogIlNQIiwNCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIlRJUE9QRVNTT0EiOiAiMiINCiAgICAgICAgICAgICAgICAgICAgICAgIH0sDQogICAgICAgICAgICAgICAgICAgICAgICB7DQogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICJDR0MiOiAiMDc1NDk3MDcwMDAxMDkiLA0KICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAiSU5TQyI6ICIxMjEiLA0KICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAiVUYiOiAiU1AiLA0KICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAiVElQT1BFU1NPQSI6ICIyIg0KICAgICAgICAgICAgICAgICAgICAgICAgfQ0KICAgICAgICAgICAgXSwNCiAgICAgICAgICAgICJQQVJBTUVUUk9TIjogew0KICAgICAgICAgICAgICAgICAgICAgICAgIkFOTyI6ICIyMDE3IiwNCiAgICAgICAgICAgICAgICAgICAgICAgICJNRVMiOiAiMDUiDQogICAgICAgICAgICB9DQp9DQogDQo=

Mensagem JSON sem codificação 64:

{

            "EMPRESA": [{

                                   "CGC": "07549707000109",

                                   "INSC": "121",

                                   "UF": "SP",

                                   "TIPOPESSOA": "2"

                        },

                        {

                                   "CGC": "07549707000109",

                                   "INSC": "121",

                                   "UF": "SP",

                                   "TIPOPESSOA": "2"

                        }

            ],

            "PARAMETROS": {

                        "ANO": "2017",

                        "MES": "05"

            }

}

Retorno Negativo:

{

                "RESULT": {

                                               "PRODUCAO": {

                                                                              "TOTALDOCUMENTOS": 0,

                                                                              "TOTALTENTATIVAS": 0

                                                                              },

                                               "HOMOLOGACAO": {

                                                                              "TOTALDOCUMENTOS": 0,

                                                                              "TOTALTENTATIVAS": 0

                                                                              }

                                               },

                "error":" Informe os dados da empresa corretamente. "

}

Retorno Positivo: 

{

                "RESULT": {

                                               "PRODUCAO": {

                                                                              "TOTALDOCUMENTOS": 100,

                                                                              "TOTALTENTATIVAS": 360

                                                                              },

                                               "HOMOLOGACAO": {

                                                                              "TOTALDOCUMENTOS": 250,

                                                                              "TOTALTENTATIVAS": 1000

                                                                              }

                                               },

                "error":""

}

Função: TSSBilling()

A função deverá receber a mensagem JSON já convertida pela função FwJsonDeserialize(). Será realizado a validação das informações da requisição, assim será realizado a busca dos documentos das entidades envolvidas.