Esse documento pode conter informação confidencial e/ou privilegiada, sendo seu sigilo protegido por lei. Se você não for o destinatário ou a pessoa autorizada a ter este documento, não pode usar, copiar ou divulgar as informações nela contidas ou tomar qualquer ação baseada nessas informações. Copyright 2018 - ServiceNet Tecnologia
A API Gestão apresenta as funcionalidades ligadas a autenticação e lógica de negócio do sistema Kronos. Essa API está toda baseada no protocolo de comunicação HTTP ou HTTPS, dependendo da necessidade de segurança da informação, utilizando principalmente o verbo POST para troca de mensagens em padrão JSON. Cada funcionalidade da lógica do negócio é descrita o formato da URL e um exemplo da
mensagem em JSON, tanto para a requisição quanto para a resposta. Todas as funcionalidades aqui apresentadas necessitarão de um AccessToken que será obtido após o processo de autenticação no sistema.
Autenticação descrita no item 3 do documento (credenciais serão passados ao responsável técnico via email direto);
Operações de consulta de dados; Operações de inserção de dados; Operações de atualização de dados;
Toda a fase de homologação desta solução é realizada com testes assistidos pela equipe ServiceNet;
Validada a homologação será disponibilizado o ambiente de produção mediante cadastro em
API Gestão - v2.4.2
1 Introdução
2 Integração
2.1 Implementação
2.2 Homologação
2.3 Validação
documento de homologação.
O Integration Application solicita um token de acesso (accessToken). O IP do cliente deve ser validado para esse tipo de autenticação (simple). O grant e idCliente serão fornecidos pela ServiceNet Tecnologia. Host para homologação: https://godin-auth-arrecada-dev.herokuapp.com
Request:
Método: POST
URL: /auth/simple/getAccessToken Parâmetros url: nenhum
Header HTTP: Authorization: AuthSnet grant="09ab33df0a6c6e7f3f2349308d381da4", idC liente="1"
Body: vazio
Host para produção: https://godin-auth-arrecada.herokuapp.com Request:
3 Autenticação
3.1 Arquitetura
Método: POST
URL: /auth/simple/getAccessToken Parâmetros url: nenhum
Header HTTP: Authorization: AuthSnet grant="09ab33df0a6c6e7f3f2349308d381da4", idC liente="1" Body: vazio Response: { "codResposta": "000", "mensagem": "", "accessToken": "6758c93d2c9f48bb84acd3a587247e35f2c378d400a20c", "expiraEm": 1200, "serverBusiness": { "security": false, "host": "", "porta": 0 } }
O accessToken será formado por 40 caracteres, constituído apenas de dígitos hexadecimais, e é divido em 2 partes. A primeira é uma sequência gerada pela biblioteca libuuid do linux
(http://linux.die.net/man/3/uuid_generate).
A segunda parte refere-se ao CRC-32 do timestamp do momento em que foi criado o token. Logo, teríamos accessToken = uuid + crc-32(timestamp).
Exemplo: f47ac10b58cc4372a5670e02b2c3d479af2075C9
O refresh token serve para prolongar o tempo de vida do token. Request:
3.3 Etapa B
3.4 Geração do accessToken
Método: POST
URL: /auth/simple/getAccessToken Parâmetros url: nenhum
Header HTTP: Authorization: AuthSnet grant="09ab33df0a6c6e7f3f2349308d381da4", idC liente="1" Body: vazio Response: { "codResposta": "000", "mensagem": "" }
Em todos os requests, OBRIGATORIAMENTE, deve incluir o header HTTP, conforme exemplo abaixo: Host para homologação: https://godin-logistica-arrecada-dev.herokuapp.com
Header HTTP:
AuthSnet accessToken=“0be228d2471447d894a880ab9653425fe86a303f00a20b”, idCliente= “1"
Arrecadadoratoken Arrecada accessToken=“17DA63BA2E7215675A7F17B5FCEAF”
O accessToken é obtido após autenticação bem sucedida, ou seja, codResposta igual “000”. Todo response retornará um json com no mínimo os campos: codResposta e mensagem. Quando o
processamento é bem sucedido, codResposta é igual a "000". Caso contrário, um código de erro referente ao problema.
4 Transações de Negócio
Todos os números relacionados a valores monetários(campos de ponto flutuante) devem ser enviados como Long(valor * 100).
Exemplo:
Valor real: 103,57
Valor a ser enviado: 10357
Campos Float(de ponto flutuante) foram especificados. Todos os outros campos numéricos devem ser considerados Inteiros.
Campos String são alfanuméricos e tem seu tamanho limite. A informação do tamanho máximo de cada campo segue no final dos campos do JSON exemplo das transações, como no exemplo abaixo: Exemplo:
{
"nomePos": "nome pos", max: 20 }
Campos Booleanos são preenchidos com uma das duas opções: false ou true. Segue link para melhor entendimento dos campos do CRUD:
https://manual.servicenet.com.br/doku.php?id=manuais:kronos
Request:
Método: POST
URL: /api/v1/arrecada/subredes Parâmetros url: vazio
Body: {
"nome" : "nome da subrede", max: 40 "nomePos" : "nome pos" , max: 20 "propria" : false } Response: { "codResposta":"201", "mensagem":"OK", "subRede": [{ "idSubRede":285, "nome":"nome da subrede", "nomePos":"nome pos", "propria":false }] } Request: Método: GET URL: /api/v1/arrecada/subredes Parâmetros url: vazio
Body: vazio
Response (todas as subredes):
4.3 Subrede
4.3.1 Adicionar Subrede
{ "codResposta":"201", "mensagem":"OK", "subRede": [ { "idSubRede":285, "nome":"nome da subrede", "nomePos":"nome pos", "propria":false }, { "idSubRede"170, "nome":"testeJ", "nomePos":"testeA", "propria":false } ] } Request: Método: GET URL: /api/v1/arrecada/subredes?nome= Parâmetros url: nome da subrede Body: vazio Response: { "codResposta":"201", "mensagem":"OK", "subRede": [ { "idSubRede":285, "nome":"nome da subrede", "nomePos":"nome pos", "propria":false } ] } Request:
4.3.3 Atualizar Subrede
Método: PUT
URL: /api/v1/arrecada/subredes/{id} Parâmetros url: id da subrede
Body: {
"nome" : "nome da subrede", max: 40 "nomePos" : "nome pos" , max: 20 "propria" : false } Response: { "codResposta":"201", "mensagem":"OK", "subRede": [ { "idSubRede":285, "nome":"nome da subrede", "nomePos":"nome pos", "propria":false } ] } Request:
4.4 Estabelecimento
4.4.1 Adicionar Estabelecimento
Método: POST
URL: /api/v1/arrecada/estabelecimentos Parâmetros url: vazio
Body: { "idSubRede" : 1, (obrigatório) "idEstado" : 1, "idCidade" : 1, (obrigatório)
"numEstab" : "nome da subrede", max: 15 (obrigatório) "razaoSocial" : "razao social", max: 50 (obrigatório) "nomeFantasia" : "nome fantasia", max: 50 (obrigatório) "cnpj" : "cnpj", max: 18
"inscEstadual" : "inscricao estadual", max: 30 "numContrato" : "num con", max: 10
"controleInterno" : "controle interno", max: 20 "ativo" : true, (obrigatório)
"logradouro" : "logradouro", max: 15 "endereco" : "endereco", max: 60 "numero" : "numero", max: 10
"complemento" : "complemento", max: 50 "bairro" : "bairro", max: 25
"cep" : "cep", max: 10 "ddd1" : "ddd1", max: 5 "tel1" : "telefone", max: 18 "ddd2" : "ddd2", max: 5
"tel2" : "telefone2", max: 18
"nomeContato" : "nome contato", max: 40 "email" : "email", max: 50
"idConsultor" : 1,
"metodoContato" : "metodo contato", max: 200 "nomeSocio1" : "socio nome", max: 40
"nascSocio1" : "2017-01-01", "cpfSocio1" : "socio cpf", max: 14 "rgSocio1" : "socio rg", max: 15
"orgaoRgSocio1" : "socio orgao expedidor", max: 40 "nomeSocio2" : "socio 2 nome", max: 40
"nascSocio2" : "2017-02-02",
"cpfSocio2" : "socio 2 cpf", max: 14 "rgSocio2" : "socio 2 rg", max: 15
"orgaoRgSocio2" : "socio 2 orgao expedidor", max: 15 "coban" : "coban", max: 14
"mci" : "mci", max: 14
"numAgencia" : "numero agencia", max: 14 "verao" : true, (obrigatório)
} Response:
{ "codResposta":"201", "mensagem":"OK", "estabs": [ { "id": 5919, "idSubRede": 1, "idEstado": 1, "idCidade": 1, "idConsultor": 1, "idSeguimento": 1, "numEstab":"nome da subrede", "nomeFantasia":"nome fantasia", "razaoSocial":"razao social", "obs":"", "ativo":true, "cnpj":"cnpj", "numAgencia":"numero agencia", "inscEstadual":"inscricao estadual", "numContrato":"num con", "controleInterno":"controle interno", "logradouro":"logradouro", "endereco":"endereco", "numero":"numero", "complemento":"complemento", "bairro":"bairro", "cep":"cep", "ddd1":"ddd1", "tel1":"telefone", "ddd2":"ddd2", "tel2":"telefone2", "nomeContato":"nome contato", "emailContato":"", "metodoContato":"metodo contato", "nomeSocio1":"socio nome", "nascSocio1":"2017-01-01", "cpfSocio1":"socio cpf", "rgSocio1":"socio rg",
"orgaoRgSocio1":"socio orgao expedidor", "nomeSocio2":"socio 2 nome",
"nascSocio2":"2017-02-02", "cpfSocio2":"socio 2 cpf", "rgSocio2":"socio 2 rg",
"orgaoRgSocio2":"socio 2 orgao expedidor", "coban":"coban",
"mci":"mci",
"verao":true, "arquivado":false } ] } Request: Método: GET URL: /api/v1/arrecada/estabelecimentos Body: Vazio
Response (todos os estabelecimentos): { "codResposta":"201", "mensagem":"OK", "estabs": [ { "id": 5919, "idSubRede": 1, "idEstado": 1, "idCidade": 1, "idConsultor": 1, "idSeguimento": 1, "numEstab":"nome da subrede", "nomeFantasia":"nome fantasia", "razaoSocial":"razao social", "obs":"", "ativo":true, "cnpj":"cnpj", "numAgencia":"numero agencia", "inscEstadual":"inscricao estadual", "numContrato":"num con", "controleInterno":"controle interno", "logradouro":"logradouro", "endereco":"endereco", "numero":"numero", "complemento":"complemento", "bairro":"bairro", "cep":"cep", "ddd1":"ddd1", "tel1":"telefone", "ddd2":"ddd2",
4.4.2 Consultar Estabelecimento
"tel2":"telefone2", "nomeContato":"nome contato", "emailContato":"", "metodoContato":"metodo contato", "nomeSocio1":"socio nome", "nascSocio1":"2017-01-01", "cpfSocio1":"socio cpf", "rgSocio1":"socio rg",
"orgaoRgSocio1":"socio orgao expedidor", "nomeSocio2":"socio 2 nome",
"nascSocio2":"2017-02-02", "cpfSocio2":"socio 2 cpf", "rgSocio2":"socio 2 rg",
"orgaoRgSocio2":"socio 2 orgao expedidor", "coban":"coban", "mci":"mci", "conciliaCbf":false, "verao":true, "arquivado":false } ] } Request: Método: GET URL: /api/v1/arrecada/estabelecimentos/{id} Body: Vazio Response: { "codResposta":"201", "mensagem":"OK", "estabs": [ { "id": 5919, "idSubRede": 1, "idEstado": 1, "idCidade": 1, "idConsultor": 1, "idSeguimento": 1, "numEstab":"nome da subrede", "nomeFantasia":"nome fantasia", "razaoSocial":"razao social", "obs":"",
"ativo":true, "cnpj":"cnpj", "numAgencia":"numero agencia", "inscEstadual":"inscricao estadual", "numContrato":"num con", "controleInterno":"controle interno", "logradouro":"logradouro", "endereco":"endereco", "numero":"numero", "complemento":"complemento", "bairro":"bairro", "cep":"cep", "ddd1":"ddd1", "tel1":"telefone", "ddd2":"ddd2", "tel2":"telefone2", "nomeContato":"nome contato", "emailContato":"", "metodoContato":"metodo contato", "nomeSocio1":"socio nome", "nascSocio1":"2017-01-01", "cpfSocio1":"socio cpf", "rgSocio1":"socio rg",
"orgaoRgSocio1":"socio orgao expedidor", "nomeSocio2":"socio 2 nome",
"nascSocio2":"2017-02-02", "cpfSocio2":"socio 2 cpf", "rgSocio2":"socio 2 rg",
"orgaoRgSocio2":"socio 2 orgao expedidor", "coban":"coban", "mci":"mci", "conciliaCbf":false, "verao":true, "arquivado":false } ] } Request: Método: GET
URL: /api/v1/arrecada/estabelecimentos?numEstab=00001&nomeFantasia=T Estab Fan&sub Rede=1&cidade=1&ativo=true&arquivado=false
Body: Vazio Response:
{ "codResposta":"201", "mensagem":"OK", "estabs": [ { "id": 5919, "idSubRede": 1, "idEstado": 1, "idCidade": 1, "idConsultor": 1, "idSeguimento": 1, "numEstab":"nome da subrede", "nomeFantasia":"nome fantasia", "razaoSocial":"razao social", "obs":"", "ativo":true, "cnpj":"cnpj", "numAgencia":"numero agencia", "inscEstadual":"inscricao estadual", "numContrato":"num con", "controleInterno":"controle interno", "logradouro":"logradouro", "endereco":"endereco", "numero":"numero", "complemento":"complemento", "bairro":"bairro", "cep":"cep", "ddd1":"ddd1", "tel1":"telefone", "ddd2":"ddd2", "tel2":"telefone2", "nomeContato":"nome contato", "emailContato":"", "metodoContato":"metodo contato", "nomeSocio1":"socio nome", "nascSocio1":"2017-01-01", "cpfSocio1":"socio cpf", "rgSocio1":"socio rg",
"orgaoRgSocio1":"socio orgao expedidor", "nomeSocio2":"socio 2 nome",
"nascSocio2":"2017-02-02", "cpfSocio2":"socio 2 cpf", "rgSocio2":"socio 2 rg",
"orgaoRgSocio2":"socio 2 orgao expedidor", "coban":"coban",
"mci":"mci",
"verao":true, "arquivado":false } ] } Request:
4.4.3 Atualizar Estabelecimento
Método: PUT URL: /api/v1/arrecada/estabelecimentos/{id} Body: { "idSubRede" : 1, (obrigatório) "idEstado" : 1, "idCidade" : 1, (obrigatório)
"numEstab" : "nome da subrede", max: 15 (obrigatório) "razaoSocial" : "razao social", max: 50 (obrigatório) "nomeFantasia" : "nome fantasia", max: 50 (obrigatório) "cnpj" : "cnpj", max: 18
"inscEstadual" : "inscricao estadual", max: 30 "numContrato" : "num con", max: 10
"controleInterno" : "controle interno", max: 20 "ativo" : true, (obrigatório)
"logradouro" : "logradouro", max: 15 "endereco" : "endereco", max: 60 "numero" : "numero", max: 10
"complemento" : "complemento", max: 50 "bairro" : "bairro", max: 25
"cep" : "cep", max: 10 "ddd1" : "ddd1", max: 5 "tel1" : "telefone", max: 18 "ddd2" : "ddd2", max: 5
"tel2" : "telefone2", max: 18
"nomeContato" : "nome contato", max: 40 "email" : "email", max: 50
"idConsultor" : 1,
"metodoContato" : "metodo contato", max: 200 "nomeSocio1" : "socio nome", max: 40
"nascSocio1" : "2017-01-01", "cpfSocio1" : "socio cpf", max: 14 "rgSocio1" : "socio rg", max: 15
"orgaoRgSocio1" : "socio orgao expedidor", max: 40 "nomeSocio2" : "socio 2 nome", max: 40
"nascSocio2" : "2017-02-02",
"cpfSocio2" : "socio 2 cpf", max: 14 "rgSocio2" : "socio 2 rg", max: 15
"orgaoRgSocio2" : "socio 2 orgao expedidor", max: 15 "coban" : "coban", max: 14
"mci" : "mci", max: 14
"numAgencia" : "numero agencia", max: 14 "verao" : true, (obrigatório)
} Response:
{ "codResposta":"201", "mensagem":"OK", "estabs": [ { "id": 5919, "idSubRede": 1, "idEstado": 1, "idCidade": 1, "idConsultor": 1, "idSeguimento": 1, "numEstab":"nome da subrede", "nomeFantasia":"nome fantasia", "razaoSocial":"razao social", "obs":"", "ativo":true, "cnpj":"cnpj", "numAgencia":"numero agencia", "inscEstadual":"inscricao estadual", "numContrato":"num con", "controleInterno":"controle interno", "logradouro":"logradouro", "endereco":"endereco", "numero":"numero", "complemento":"complemento", "bairro":"bairro", "cep":"cep", "ddd1":"ddd1", "tel1":"telefone", "ddd2":"ddd2", "tel2":"telefone2", "nomeContato":"nome contato", "emailContato":"", "metodoContato":"metodo contato", "nomeSocio1":"socio nome", "nascSocio1":"2017-01-01", "cpfSocio1":"socio cpf", "rgSocio1":"socio rg",
"orgaoRgSocio1":"socio orgao expedidor", "nomeSocio2":"socio 2 nome",
"nascSocio2":"2017-02-02", "cpfSocio2":"socio 2 cpf", "rgSocio2":"socio 2 rg",
"orgaoRgSocio2":"socio 2 orgao expedidor", "coban":"coban",
"mci":"mci",
"verao":true, "arquivado":false } ] } Request: Método: POST URL: /api/v1/arrecada/lojas Body: { "idEstab": 2,
"nomeFantasia": "nome fantasia", "naoConciliar": false, "conciliarAteLimite": false, "lojaTransacional": false, "bloquearRecebimentoCoban": false, "Limite": 100, "meta": 321, "processaGcbSubEst": false, "conciliarPorCbf801": false, "migradoCbf801": false, "bloquearRecebimentoConvenio": false, "limiteConvenio": 321, "tipoConciliacaoConvenio": 12, "bloquearRececimentoRecarga": false, "limiteRecarga": 3213, "tipoConciliacaoRecarga": 1, "alivioSegunda": false, "alivioTerca": false, "alivioQuarta": false, "alivioQuinta": false, "alivioSexta": false, "conciliaCofre": false, "conciliaSangria": false, "conciliaAgrupado": false, "emitiBoletoAbertura": false, "idEmpresaCofre": 1, "emissaoAutoAlivio": true, "anteciparComissaoRecarga" : true }
4.5 Lojas
4.5.1 Adicionar Loja
Response: { "codResposta": "201", "mensagem": "OK", "lojas": [ { "id": 6719, "idEstab": 2, "numLoja": 0, "cnpj": "", "controleInterno": "", "razaoSocial": "",
"nomeFantasia": "nome fantasia", "idConsultor": 0, "ativo": false, "naoConciliar": false, "conciliarAteLimite": false, "perfilAutoGcb": false, "endereco": "", "complemento": "", "bairro": "", "idCidade": 0, "cep": "", "ddd1": "", "telefone1": "", "ramal1": "", "ddd2": "", "telefone2": "", "ramal2": "", "ddd3": "", "telefone3": "", "ramal3": "", "nomeContato": "", "idBanco": 0, "agencia": "", "conta": "", "nomeFavorecido": "", "cpfCnpj": "", "lojaTransacional": false, "bloquearRecebimentoCoban": false, "Limite": 100, "tipoConciliacaoGcb": 0, "meta": 321, "processaGcbSubEst": false, "horaInicio": "", "horaFim": "",
"conciliarPorCbf801": false, "migradoCbf801": false, "idPerfilComissao": 0, "bloquearRecebimentoConvenio": false, "limiteConvenio": 321, "tipoConciliacaoConvenio": 12, "bloquearRececimentoRecarga": false, "limiteRecarga": 3213, "tipoConciliacaoRecarga": 1, "alivioSegunda": false, "alivioTerca": false, "alivioQuarta": false, "alivioQuinta": false, "alivioSexta": false, "conciliaCofre": false, "conciliaSangria": false, "arquivado": false, "contaCorrente": "", "tipoConciliacaoGeral": 0, "limiteArrecadacaoGeral": 0, "serialCofre": "", "conciliaAgrupado": false, "emitiBoletoAbertura": false, "limiteBoletoAlivio": 0, "idEmpresaCofre": 1, "descricao": "", "ccAgencia": 0, "emissaoAutoAlivio": true, "anteciparComissaoRecarga" : true } ] } Request: Método: GET URL: /api/v1/arrecada/lojas Body: vazio
Response (todas as lojas): {
"codResposta": "201", "mensagem": "OK", "lojas": [
{ "id": 6719, "idEstab": 2, "numLoja": 0, "cnpj": "", "controleInterno": "", "razaoSocial": "",
"nomeFantasia": "nome fantasia", "idConsultor": 0, "ativo": false, "naoConciliar": false, "conciliarAteLimite": false, "perfilAutoGcb": false, "endereco": "", "complemento": "", "bairro": "", "idCidade": 0, "cep": "", "ddd1": "", "telefone1": "", "ramal1": "", "ddd2": "", "telefone2": "", "ramal2": "", "ddd3": "", "telefone3": "", "ramal3": "", "nomeContato": "", "idBanco": 0, "agencia": "", "conta": "", "nomeFavorecido": "", "cpfCnpj": "", "lojaTransacional": false, "bloquearRecebimentoCoban": false, "Limite": 100, "tipoConciliacaoGcb": 0, "meta": 321, "processaGcbSubEst": false, "horaInicio": "", "horaFim": "", "conciliarPorCbf801": false, "migradoCbf801": false, "idPerfilComissao": 0, "bloquearRecebimentoConvenio": false, "limiteConvenio": 321, "tipoConciliacaoConvenio": 12, "anteciparComissao": false,
"bloquearRececimentoRecarga": false, "limiteRecarga": 3213, "tipoConciliacaoRecarga": 1, "alivioSegunda": false, "alivioTerca": false, "alivioQuarta": false, "alivioQuinta": false, "alivioSexta": false, "conciliaCofre": false, "conciliaSangria": false, "arquivado": false, "contaCorrente": "", "tipoConciliacaoGeral": 0, "limiteArrecadacaoGeral": 0, "serialCofre": "", "conciliaAgrupado": false, "emitiBoletoAbertura": false, "limiteBoletoAlivio": 0, "idEmpresaCofre": 1, "descricao": "", "ccAgencia": 0, "emissaoAutoAlivio": true, "anteciparComissaoRecarga" : true } ] } Request: Método: GET
URL: /api/v1/arrecada/lojas?numLoja=1&nomeFantasia=nome fantasia&idEstab=1&cidade= 1&controleInterno=0000&arquivado=false Body: vazio Response: { "codResposta": "201", "mensagem": "OK", "lojas": [ { "id": 6719, "idEstab": 2, "numLoja": 1, "cnpj": "", "controleInterno": "", "razaoSocial": "",
"nomeFantasia": "nome fantasia", "idConsultor": 0, "ativo": false, "naoConciliar": false, "conciliarAteLimite": false, "perfilAutoGcb": false, "endereco": "", "complemento": "", "bairro": "", "idCidade": 0, "cep": "", "ddd1": "", "telefone1": "", "ramal1": "", "ddd2": "", "telefone2": "", "ramal2": "", "ddd3": "", "telefone3": "", "ramal3": "", "nomeContato": "", "idBanco": 0, "agencia": "", "conta": "", "nomeFavorecido": "", "cpfCnpj": "", "lojaTransacional": false, "bloquearRecebimentoCoban": false, "Limite": 100, "tipoConciliacaoGcb": 0, "meta": 321, "processaGcbSubEst": false, "horaInicio": "", "horaFim": "", "conciliarPorCbf801": false, "migradoCbf801": false, "idPerfilComissao": 0, "bloquearRecebimentoConvenio": false, "limiteConvenio": 321, "tipoConciliacaoConvenio": 12, "anteciparComissao": false, "bloquearRececimentoRecarga": false, "limiteRecarga": 3213, "tipoConciliacaoRecarga": 1, "alivioSegunda": false, "alivioTerca": false, "alivioQuarta": false, "alivioQuinta": false,
"alivioSexta": false, "conciliaCofre": false, "conciliaSangria": false, "arquivado": false, "contaCorrente": "", "tipoConciliacaoGeral": 0, "limiteArrecadacaoGeral": 0, "serialCofre": "", "conciliaAgrupado": false, "emitiBoletoAbertura": false, "limiteBoletoAlivio": 0, "idEmpresaCofre": 1, "descricao": "", "ccAgencia": 0, "emissaoAutoAlivio": true, "anteciparComissaoRecarga" : true } ] } Request:
4.5.3 Atualizar Loja
Método: PUT
URL: /api/v1/arrecada/lojas/{id} Body:
{
"idEstab": 2,
"nomeFantasia": "nome fantasia", "naoConciliar": false, "conciliarAteLimite": false, "lojaTransacional": false, "bloquearRecebimentoCoban": false, "Limite": 100, "meta": 321, "processaGcbSubEst": false, "conciliarPorCbf801": false, "migradoCbf801": false, "bloquearRecebimentoConvenio": false, "limiteConvenio": 321, "tipoConciliacaoConvenio": 12, "bloquearRececimentoRecarga": false, "limiteRecarga": 3213, "tipoConciliacaoRecarga": 1, "alivioSegunda": false, "alivioTerca": false, "alivioQuarta": false, "alivioQuinta": false, "alivioSexta": false, "conciliaCofre": false, "conciliaSangria": false, "conciliaAgrupado": false, "emitiBoletoAbertura": false, "idEmpresaCofre": 1, "emissaoAutoAlivio": true, "anteciparComissaoRecarga" : true } Response: { "codResposta": "201", "mensagem": "OK", "lojas": [ { "id": 6719, "idEstab": 2, "numLoja": 1, "cnpj": "",
"controleInterno": "", "razaoSocial": "",
"nomeFantasia": "nome fantasia", "idConsultor": 0, "ativo": false, "naoConciliar": false, "conciliarAteLimite": false, "perfilAutoGcb": false, "endereco": "", "complemento": "", "bairro": "", "idCidade": 0, "cep": "", "ddd1": "", "telefone1": "", "ramal1": "", "ddd2": "", "telefone2": "", "ramal2": "", "ddd3": "", "telefone3": "", "ramal3": "", "nomeContato": "", "idBanco": 0, "agencia": "", "conta": "", "nomeFavorecido": "", "cpfCnpj": "", "lojaTransacional": false, "bloquearRecebimentoCoban": false, "Limite": 100, "tipoConciliacaoGcb": 0, "meta": 321, "processaGcbSubEst": false, "horaInicio": "", "horaFim": "", "conciliarPorCbf801": false, "migradoCbf801": false, "idPerfilComissao": 0, "bloquearRecebimentoConvenio": false, "limiteConvenio": 321, "tipoConciliacaoConvenio": 12, "anteciparComissao": false, "bloquearRececimentoRecarga": false, "limiteRecarga": 3213, "tipoConciliacaoRecarga": 1, "alivioSegunda": false, "alivioTerca": false,
"alivioQuarta": false, "alivioQuinta": false, "alivioSexta": false, "conciliaCofre": false, "conciliaSangria": false, "arquivado": false, "contaCorrente": "", "tipoConciliacaoGeral": 0, "limiteArrecadacaoGeral": 0, "serialCofre": "", "conciliaAgrupado": false, "emitiBoletoAbertura": false, "limiteBoletoAlivio": 0, "idEmpresaCofre": 1, "descricao": "", "ccAgencia": 0, "emissaoAutoAlivio": true, "anteciparComissaoRecarga" : true } ] } Request:
4.6 Terminal
4.6.1 Adicionar Terminal
Método: POST URL: /api/v1/arrecada/terminais Body: { "numTerminal": "012", "idEstab": 5, "idLoja": 808, "apresentacao": "", "endereco": "", "bairro": "", "idCidade": 250, "cep": "", "senhaSupervisao": "1", "ccPDV": "0", "horaAutoTransmit": "1900", "niiFechamento": 20, "inicioRel1": "", "inicioRel2": "", "fimRel1": "", "fimRel2": "", "senhaApagarLote": "222222222", "solicitaTroco": false } Response: { "codResposta": "201", "mensagem": "OK", "terminais": [ { "id": 38531, "numTerminal": "012", "idEstab": 5, "idLoja": 808, "apresentacao": "", "endereco": "", "bairro": "", "idCidade": 250, "cep": "", "senhaSupervisao": "1", "ccPDV": "0", "horaAutoTransmit": "1900", "niiFechamento": 20, "inicioRel1": "", "inicioRel2": "",
"fimRel1": "", "fimRel2": "", "senhaApagarLote": "222222222", "observacao": "", "ccConvenio": "", "ccAgencia": "", "idConsultor": 0, "qtdEstorno": 0, "ativo": false, "bloqueado": false, "reImprimirComprovante": false, "confirmarValorConta": false, "processarLoteContas": false, "fazRecarga": false, "operarOline": false, "validarSerialPos": false, "inicializar": false, "naoExibirEmissaoAvulsa": false, "idTipoPinPad": 0, "portPinPad": 0, "trocarPerfilGcb": false, "idPerfilTerminalGcb": 0, "valorLimiteArrecadacao": 0, "valorLimiteTroco": 0, "confirmaDadosRecarga": false, "bloqueioReimpressaoCoban": false, "arquivado": false, "aliviarIlimitado": false, "fechamento": false, "idModeloTerminal": 0, "idSituacao": 0, "solicitaTroco": false } ] } Request: Método: GET URL: /api/v1/arrecada/terminais Body: vazio
Response (todos os terminais): {
"codResposta": "201", "mensagem": "OK", "terminais": [ { "id": 38531, "numTerminal": "012", "idEstab": 5, "idLoja": 808, "apresentacao": "", "endereco": "", "bairro": "", "idCidade": 250, "cep": "", "senhaSupervisao": "1", "ccPDV": "0", "horaAutoTransmit": "1900", "niiFechamento": 20, "inicioRel1": "", "inicioRel2": "", "fimRel1": "", "fimRel2": "", "senhaApagarLote": "222222222", "observacao": "", "ccConvenio": "", "ccAgencia": "", "idConsultor": 0, "qtdEstorno": 0, "ativo": false, "bloqueado": false, "reImprimirComprovante": false, "confirmarValorConta": false, "processarLoteContas": false, "fazRecarga": false, "operarOline": false, "validarSerialPos": false, "inicializar": false, "naoExibirEmissaoAvulsa": false, "idTipoPinPad": 0, "portPinPad": 0, "trocarPerfilGcb": false, "idPerfilTerminalGcb": 0, "valorLimiteArrecadacao": 0, "valorLimiteTroco": 0, "confirmaDadosRecarga": false, "bloqueioReimpressaoCoban": false, "arquivado": false, "aliviarIlimitado": false, "fechamento": false,
"idModeloTerminal": 0, "idSituacao": 0, "solicitaTroco": false } ] } Request: Método: GET
URL: /api/v1/arrecada/terminais?idTerminal=1&numTerminal= 012&idEstab=1&idLoja=1&a tivo=true&arquivado=false Body: vazio Response: { "codResposta": "201", "mensagem": "OK", "terminais": [ { "id": 38531, "numTerminal": "012", "idEstab": 5, "idLoja": 808, "apresentacao": "", "endereco": "", "bairro": "", "idCidade": 250, "cep": "", "senhaSupervisao": "1", "ccPDV": "0", "horaAutoTransmit": "1900", "niiFechamento": 20, "inicioRel1": "", "inicioRel2": "", "fimRel1": "", "fimRel2": "", "senhaApagarLote": "222222222", "observacao": "", "ccConvenio": "", "ccAgencia": "", "idConsultor": 0, "qtdEstorno": 0, "ativo": false, "bloqueado": false, "reImprimirComprovante": false,
"confirmarValorConta": false, "processarLoteContas": false, "fazRecarga": false, "operarOline": false, "validarSerialPos": false, "inicializar": false, "naoExibirEmissaoAvulsa": false, "idTipoPinPad": 0, "portPinPad": 0, "trocarPerfilGcb": false, "idPerfilTerminalGcb": 0, "valorLimiteArrecadacao": 0, "valorLimiteTroco": 0, "confirmaDadosRecarga": false, "bloqueioReimpressaoCoban": false, "arquivado": false, "aliviarIlimitado": false, "fechamento": false, "idModeloTerminal": 0, "idSituacao": 0, "solicitaTroco": false } ] } Request:
4.6.3 Atualizar Terminal
Método: PUT URL: /api/v1/arrecada/terminais/{id} Body: { "numTerminal": "012", "idEstab": 5, "idLoja": 808, "apresentacao": "", "endereco": "", "bairro": "", "idCidade": 250, "cep": "", "senhaSupervisao": "1", "ccPDV": "0", "horaAutoTransmit": "1900", "niiFechamento": 20, "inicioRel1": "", "inicioRel2": "", "fimRel1": "", "fimRel2": "", "senhaApagarLote": "222222222", "solicitaTroco": false } Response: { "codResposta": "201", "mensagem": "OK", "terminais": [ { "id": 38531, "numTerminal": "012", "idEstab": 5, "idLoja": 808, "apresentacao": "", "endereco": "", "bairro": "", "idCidade": 250, "cep": "", "senhaSupervisao": "1", "ccPDV": "0", "horaAutoTransmit": "1900", "niiFechamento": 20, "inicioRel1": "", "inicioRel2": "",
"fimRel1": "", "fimRel2": "", "senhaApagarLote": "222222222", "observacao": "", "ccConvenio": "", "ccAgencia": "", "idConsultor": 0, "qtdEstorno": 0, "ativo": false, "bloqueado": false, "reImprimirComprovante": false, "confirmarValorConta": false, "processarLoteContas": false, "fazRecarga": false, "operarOline": false, "validarSerialPos": false, "inicializar": false, "naoExibirEmissaoAvulsa": false, "idTipoPinPad": 0, "portPinPad": 0, "trocarPerfilGcb": false, "idPerfilTerminalGcb": 0, "valorLimiteArrecadacao": 0, "valorLimiteTroco": 0, "confirmaDadosRecarga": false, "bloqueioReimpressaoCoban": false, "arquivado": false, "aliviarIlimitado": false, "fechamento": false, "idModeloTerminal": 0, "idSituacao": 0, "solicitaTroco": false } ] }
4.7 Operador
4.7.1 Adicionar Operador
Método: POST URL: /api/v1/arrecada/terminais/{id} Body: { "nome": "Teste", "login": 8891, "senha": 11, "ativo": true, "id_terminal": 0, "id_loja": 0, "matricula": "12", "email": "", "senha_email": "123456", "chave_j": "J1234569", "login_cofre": "123459", "lider": false, "mestre": false } Response: { "codResposta": "200", "mensagem": "OK", "operador": { "id": 12682, "nome": "Teste", "login": 8891, "senha": 11, "ativo": true, "id_terminal": 0, "id_loja": 0, "matricula": "12", "email": "", "senha_email": "123456", "chave_j": "J1234569", "login_cofre": "123459", "lider": false, "mestre": false } }
{
"codResposta": "403",
"mensagem": "Já existe um operador com este login." }
Método: PUT
URL: /api/v1/arrecada/operador/{idOperador} Body:
{
"nome": "Teste De Atualizacao", "login": 8891, "senha": 11, "ativo": true, "id_terminal": 0, "id_loja": 0, "matricula": "1225", "email": "", "senha_email": "123456", "chave_j": "J1234569", "login_cofre": "123459", "lider": false, "mestre": false } Response:
4.7.2 Atualizar Operador
{
"codResposta": "200", "mensagem": "OK", "operador": { "id": 12682,
"nome": "Teste De Atualizacao", "login": 8891, "senha": 11, "ativo": true, "id_terminal": 0, "id_loja": 0, "matricula": "1225", "email": "", "senha_email": "123456", "chave_j": "J1234569", "login_cofre": "123459", "lider": false, "mestre": false } }
Possível Retorno de Erro: {
"codResposta": "403",
"mensagem": "Já existe um operador com este login." } Método: GET URL: /api/v1/arrecada/operadores?nome=NOME&login=LOGIN&login_cofre=LOGIN_COFRE&num ero_loja=NUMERO_LOJA&num_terminal=NUM_TERMINAL&email=EMAIL Body: {} Response:
4.7.3 Obter Operador
{ "codResposta": "200", "mensagem": "OK", "operadores": [ { "id": 1260, "nome": "OPERADOR 1", "login": 1, "senha": 1, "ativo": true, "id_arrecadadora": 9, "id_terminal": 16197, "id_loja": 0, "matricula": "0", "email": "", "senha_email": "", "chave_j": "", "login_cofre": "", "lider": false, "mestre": false } ] }
Possível Retorno de Erro: {
"message": "Erro ao obter operador", "code": "500",
"erro": "Não houve registros no retorno da query" } Método: POST URL: /api/v1/arrecada/acessocard/cadastrar/cartoes Body: { "pan": "PAN", "proxy": "PROXY", } Response:
4.8 Cartão AcessoCard
{ "codResposta": "201", "mensagem": "OK", "cartao": { "pan": "PAN", "proxy": "PROXY", } }
Possível Retorno de Erro: {}
Método: PUT
URL: /api/v1/arrecada/acessocard/atualizar/cartoes?pan=PAN&proxy=PROXY Body:
{
"token_adesao": "TOKEN DE ADESAO" } Response: { "codResposta": "201", "mensagem": "OK", "cartao": { "pan": "PAN", "proxy": "PROXY",
"token_adesao": "TOKEN DE ADESAO" }
}
Possível Retorno de Erro: {}
4.8.2 Atualizar Cartão AcessoCard
Método: PUT URL: /api/v1/arrecada/acessocard/consulta/cartoes?pan=PAN&proxy=PROXY Body: {} Response: { "codResposta": "201", "mensagem": "OK", "cartao": { "id": 7, "pan": "PAN", "proxy": "PROXY",
"token_adesao": "TOKEN DE ADESAO" }
}
Possível Retorno de Erro: {}
Método: GET
URL por arrecadadora: /api/v1/arrecada/transacoes/consulta Body: Vazio
Método: GET
URL com filtros: /api/v1/arrecada/transacoes/consulta?idLoja=888&idConvenio=888&id Terminal=9877
Body: Vazio Response:
4.9 Transações
{ "codResposta":"201", "mensagem":"OK", "transacao":[ { "codigoBarra":"23797758900001192334150090240234561207155000", "valorPago":144.92, "valorDesconto":0.01, "valorNominal":1566.92,
"nomeConvenio":"GCB 5 BLOCOS - FICHA COMP", "nomeLoja":"BARRACA DA MONICA", "numeroLojaBB":"000001", "numeroLojaSub":"0001", "agenciaBB":"4378", "coban":"070609", "pdv":"00000001", "chaveJ":"J9318188",
"cedente":"BANCO BRADESCO S.A.",
"momentoTransacao":"2015-06-18T09:22:33.624038Z", "idConvenio": "888" } ] } Retorno de Erros: { "message": "", "code": "", "erro": "" } Método: GET URL: /api/v1/arrecada/dashboard Body: Vazio Response: { "codResposta":"000", "mensagem":"", "totalTransacionadoRede":"88888.88",
5 Dashboard
"qtdTransacionadoRede":"88888", "totalLimiteLojasRede":"8888", "totalAlivioLojasRede":"8888", "hora":"", "convenios":[ { "idConvenio":888,
"nome":"GCB 4 BLOCOS - CONVENIOS", "qtd":888
"valorTotalPorConvenio":88888 },
{
"idConvenio":888,
"nome":"GCB 5 BLOCOS - FICHA COMP", "qtd":888, "valorTotalPorConvenio":8888.88 }, { "idConvenio":888, "nome":"GCB - BENEFICIOS", "qtd":888 "valorTotalPorConvenio":888.99 }, { "idConvenio":8888, "nome":"GCB - DEPOSITO", "qtd":888, "valorTotalPorConvenio":8888 }, { "idConvenio":888,
"nome":"GCB - EXTRATO CONTA CORRENTE", "qtd":888, "valorTotalPorConvenio":0 }, { "idConvenio":8882, "nome":"GCB - GRU", "qtd":888, "valorTotalPorConvenio":8888.99 }, { "idConvenio":8886, "nome":"GCB - MCMV", "qtd":888, "valorTotalPorConvenio":8888.99 }, {
"idConvenio":8881,
"nome":"GCB - SALDO BENEFICIO", "qtd":888
"valorTotalPorConvenio":8888.99 },
{
"idConvenio":8888,
"nome":"GCB - SALDO CORRENTISTA", "qtd":888,
"valorTotalPorConvenio":0 },
{
"idConvenio":8882,
"nome":"GCB - SALDO POUPANCA", "qtd":888,
"valorTotalPorConvenio":0 },
{
"idConvenio":888,
"nome":"GCB - SAQUE CONTA CORRENTE", "qtd":888,
"valorTotalPorConvenio":88888.88 },
{
"idConvenio":8880,
"nome":"GCB - SAQUE POUPANCA", "qtd":888, "valorTotalPorConvenio":8888.88 }, { "idConvenio":888, "nome":"RECARGA", "qtd":888 "valorTotalPorConvenio":8888 } ], "transacoesPorHora":[ { "hora":6, "qtd":888, "valor":888.66 }, { "hora":7, "qtd":888, "valor":888.766 }, {
"hora":8, "qtd":888, "valor":8888.88 }, { "hora":9, "qtd":888, "valor":8888.99 }, { "hora":10, "qtd":888, "valor":88888.88 } ], "transacoesPorHora5minutos":0 } Retorno de Erros: { "message": "", "code": "", "erro": "" }
