briefing de implantação omnichannel -...

Padrão de Integração API-Contrato

Passo a passo de como Integrar a plataforma Fagron Tecnologies - Contrato.

VERSÃO COMPLETAV 1.029

ÚLTIMA ATUALIZAÇÃO 08/04/2016

Fagron Technologies – versão: 1.0.2.9

Conteúdo

Introdução.............................................................................................................................................8

Web API Contrato.........................................................................................................................................8

API Contrato - Visão Macro..................................................................................................................9

Tecnologia....................................................................................................................................................9

Homologação...............................................................................................................................................9

Obtendo Informações do Cliente.................................................................................................................9

Login.............................................................................................................................................................9

Globalização...............................................................................................................................................10

External Login................................................................................................................................10

POST api/login/token.................................................................................................................................10

Request Formats..............................................................................................................................10

Response Information........................................................................................................................10

Request Formats..............................................................................................................................11


Detalhe Cliente..............................................................................................................................11

POST api/customer/detailscustomer..........................................................................................................12

Request Formats..............................................................................................................................12


POST api/customer/updatenews................................................................................................................12

Request Formats..............................................................................................................................13


POST api/customer/getnews......................................................................................................................13

Request Formats..............................................................................................................................13


Permissão...............................................................................................................................................14

POST api/permission/area..........................................................................................................................14

Request Formats..............................................................................................................................14


Recuperar Senha...........................................................................................................................15

POST api/login/recoverpassword...............................................................................................................15

Request Formats..............................................................................................................................15


Recuperar Email............................................................................................................................16

POST api/login/recoveremail......................................................................................................................16

Request Formats..............................................................................................................................16

5



Boleto – Total de registros da Lista........................................................................................17

POST api/finance/billetlisttotal...................................................................................................................17

Request Formats..............................................................................................................................17


Boleto - Lista...................................................................................................................................18

POST api/finance/billetlist..........................................................................................................................18

Request Formats..............................................................................................................................18


Boleto - Get.....................................................................................................................................20

POST api/finance/billetget..........................................................................................................................20

Request Formats..............................................................................................................................20


Requestweb – Total de registros da Lista.............................................................................21

POST api/requestweb/listtotal...................................................................................................................21

Request Formats..............................................................................................................................22


Requestweb - Lista.......................................................................................................................22

POST api/requestweb/list...........................................................................................................................22

Request Formats..............................................................................................................................22


Requestweb - Totais....................................................................................................................23

POST api/requestweb/total........................................................................................................................23

Request Formats..............................................................................................................................24


Requestweb - Detalhe.................................................................................................................25

POST api/requestweb/detail......................................................................................................................25

Request Formats..............................................................................................................................25


Requestweb – Lista de etapas..................................................................................................27

POST api/requestweb/steps.......................................................................................................................27

Request Formats..............................................................................................................................27


Requestweb – Atualização do aviso request.......................................................................29

POST api/requestweb/updateadviceemail.................................................................................................29

Request Formats..............................................................................................................................29


6


Requestweb – Pegar o cadastro aviso request...................................................................30

POST api/requestweb/getadviceemail.......................................................................................................30

Request Formats..............................................................................................................................30


PhoneSupport – Total de registros da Lista.........................................................................31

POST api/phonesupport/listtotal................................................................................................................31

Request Formats..............................................................................................................................31


PhoneSupport - Lista....................................................................................................................32

POST api/phonesupport/list.......................................................................................................................32

Request Formats..............................................................................................................................32


PhoneSupport – Detalhe.............................................................................................................33

POST api/phonesupport/detail...................................................................................................................33

Request Formats..............................................................................................................................33


PhoneSupport – Avaliação.........................................................................................................34

POST api/phonesupport/createrating........................................................................................................34

Request Formats..............................................................................................................................35


PhoneSupport – Pegar avaliação.............................................................................................35

POST api/phonesupport/getrating.............................................................................................................35

Request Formats..............................................................................................................................35


Admninistration.............................................................................................................................36

POST api/administration/insertuser...........................................................................................................36

Request Formats..............................................................................................................................36


POST api/administration/updateuser.........................................................................................................37

Request Formats..............................................................................................................................37


POST api/administration/users...................................................................................................................38

Request Formats..............................................................................................................................38


POST api/administration/user....................................................................................................................40

Request Formats..............................................................................................................................40


7


POST api/administration/deleteuser..........................................................................................................43

Request Formats..............................................................................................................................43


POST api/administration/modules.............................................................................................................44

Request Formats..............................................................................................................................44


POST api/administration/changepassword................................................................................................46

Request Formats..............................................................................................................................46


Chat Support...................................................................................................................................47

POST api/chatsupport/products..........................................................................................................47

Request Formats..............................................................................................................................47


POST api/chatsupport/issues...............................................................................................................49

Request Formats..............................................................................................................................49


POST api/customer/detailscustomer..........................................................................................................50

Request Formats..............................................................................................................................50


Introdução

Web API Contrato

Seja bem-vindo a documentação da API Contrato.Este documento deve ser utilizado para integração com todas as operações disponíveis na API REST do Contrato

desenvolvido pela Fagron Technologies.

8


API Contrato - Visão Macro

Tecnologia

Este componente é um serviço REST e utiliza HTTP para se comunicar. Esta tecnologia é amplamente

utilizada no mercado, podemos citar empresas como Google, Facebook, LinkedIn, Netflix entre diversas

outras que disponibilizam Web APIs para serem consumidas baseadas em HTTP com REST.

O Web API, diferente do SOAP, não depende de XML para trafegar as informações, o formato padrão para

isso é JSON (Java Script Object Notation).

Saiba mais sobre REST aqui: http://pt.wikipedia.org/wiki/REST

Homologação

URLs base de ambiente

Homologação: http://api-contrato-dev.fagrontech.com.br/ Producao: http://api-contrato.fagrontech.com.br/

Para executar uma operação, combine a URL base do ambiente com caminho da operação desejado.

Todos os métodos e parâmetros da API estão descritos no guia abaixo, e deve ser utilizado para a implementação dos métodos:

Obtendo Informações do Cliente

Serão obtidas as informações do cliente no site da Fagron Tecnologies.

1-Código de Atendimento

2-E-Mail

3-Senha

Login

Autentica e autoriza um usuário através de username e senha. Se o login for efetuado com sucesso, o componente irá fornecer uma chave chamada Access Token. O Access Token é uma chave temporária que permite o acesso a todos os métodos da API durante 1 dia. Após esse período é necessário gerar outra chave, chamando novamente o método de login. Sem o Access Token, nenhum outro método da API, com

9

http://api-contrato.fagrontech.com.br/

http://api-contrato-dev.fagrontech.com.br/

http://pt.wikipedia.org/wiki/REST


exceção do registro, poderá ser utilizado. Para realizar o login o usuário informa seu e-mail e senha, o mesmo utilizado durante seu registro. Sistematicamente, ao chamar a API de login, você deve informar o código de cliente, email e senha.

Globalização

Para que as mensagens e e-mails possam ser exibidos no idioma selecionado pelo usuário, devem ser passado no header da requisição o seguinte parâmetro:

Accept-Language: es-PY

Os valores possíveis para esse parâmetro são: es-PY, pt-BR e en-US.

External LoginPOST api/login/token

Método login situação com sucesso.

Request Formats

application/json, text/json

Sample:{ "CodeAttendance": "99999", "Email": "[email protected]", "Password": "123456"}

Response Information


Sample:{ "AccessToken": "sample string 1", "Exception": null, "Expires": "2015-07-30T20:40:52.5610935+00:00", "Message": null, "Name": "Rafael Santos Cunha", "AccessService":true, "Success":true,

10


"TokenType": "bearer"

}

Método login situação com erro

Request Formats

x-www-form-urlencoded

Sample:{ "CodeAttendance": "99999", "Email": "[email protected]", "Password": "123456"}



Sample:{ "AccessToken": null "Exception": null, "Expires": "0001-01-01T00:a00:00+00:00", "Message": "Cliente não tem acesso ao site.", "Success":False, "TokenType": null,}

Detalhe ClientePOST api/customer/detailscustomer

Método para obter detalhes do cliente.Obs: O Campo Email só deve ser exibido na tela quando o usuário for Master.

Tela atual: http://www.alternate.com.br/cliente/

11


Request Formats


Sample:{ "CodeAttendance": 99999}



Sample:{ "Exception": null "Message":null, "Obj":{ "CodeAttendance": "sample string 1", "CompanyName": "sample string 2", "CNPJ": "sample string 3", "Representative": "sample string 4", "Phone": "sample string 5", "Email": "sample string 6", "Fanta": "sample string 7", "FederalUnit" : " sample string 8" }, "Succeeded": true}

POST api/customer/updatenews

Método para atualizar tabela permitindo recebimento de News pelo cliente(checkbox na tela). O próximo método lerá a situação atual do checkbox.


Request Formats


12


Sample:{

"CodeAttendance":"99999", "IsReceiveNews":"true"

}



Sample:{ "Exception": null "Message":null, "Succeeded": true}

POST api/customer/getnews

Método para ler a situação atual do checkbox.


Request Formats


Sample:{

"CodeAttendance":"99999"

}

13




Sample:{ "Exception": null "Message":null, "Obj": true, "Succeeded": true}

PermissãoPOST api/permission/area

Método para obter area e os seus modulos.


Request Formats


Sample:{

"CodeAttendance": 99999, "Email": "[email protected]", "Password": "123456"}



Sample:{ "Exception": null "Message":null, "IsMaster": true "Obj":{

14


"Modules":[ { "Id":1, "Modulo":"Área do Cliente" }, { "Id":2, "Modulo":"Legislações" } ]}, "Succeeded": true}

Recuperar Senha POST api/login/recoverpassword

Método para recuperar a senha do cliente. (Atenção: para testes eu fiz um método que volta a senha para 123456, o método é api/login/recoverpasswordback, os parâmetros são os mesmos)

Tela atual: http://www.alternate.com.br/login/formRecuperaSenha.php

Request Formats


Sample:{ "CodeAttendance": 99999, "Email": "[email protected]"}



Sample:{ "Exception": null

15


"Message":null, "Obj":{ "Return":"E-mail enviado" }, "Succeeded": true}

Recuperar Email POST api/login/recoveremail

Método para recuperar e-mail do cliente(Deve ser exibido na tela).

Tela atual: http://www.alternate.com.br/login/esqueciEmail.php

Request Formats


Sample:{ "CodeAttendance": 99999, "Password": "123456"}



Sample:{ "Exception": null "Message":null, "Obj":{ "Return":"[email protected]" }, "Succeeded": true}

16


Boleto – Total de registros da ListaPOST api/finance/billetlisttotal

Tela atual: http://www.alternate.com.br/cliente/financeiro/

Obs.: Método usado para pegar o total de registros da lista para criar a paginação.

Request Formats


Sample:{ "CodeAttendance":"99999"}



Sample:{ "Exception": null "Message":null, "ObjList":4, "Succeeded": true}

Boleto - ListaPOST api/finance/billetlist


17

http://www.alternate.com.br/cliente/financeiro/


Request Formats


Sample:{ "CodeAttendance":"99999", "AmountByPage":"10", "NumberOfPage":"1"}



Sample:{ "Exception": null "Message":null, "ObjList":[{ "Bank":"033", "CodeAttendance":9999, "CdAccount":7, "CurrentAccountNumber":"013055187", "CurrentAccountNumberDC":"1 ", "Name":"SANTANDER", "TitleNumber":"000245631", "InvoiceNumber":118418, "DueDate":"2016-04-10T00:00:00", "TitleValue":264.59, "InvoiceDate":"2016-03-31T00:00:00", "CardNumber":112, "DraweeName":"ALTERNATE SISTEMAS E INFORMATICA LTDA ", "DraweeStreetAddress":"RUA ANCHIETA,285", "DraweeNeighborhood":"BOAVENTURA", "DraweeCity":"JUNDIAI ", "DraweeCEP":"13201804", "DraweeUF":"SP", "DraweeCNPJCPF":"68962851000159", "Messages":"APOS O VENCIMENTO COBRAR MORA DE R$0,26 AO DIA\nAPOS 10/04/2016 MULTA DE R$5,29\nSUJEITO A PROTESTO SE NAO FOR PAGO NO VENCTO\nCOBRANCA ESCRITURAL.\n", "billetFixedFields":{ "TitleCurrency":"R$", "Agency":"1042",

18


"DigitAgency":"1", "TitleAcceptance":"Não", "TitleDocumentKind":"DS", "TitleOurNumber":"00024563", "CedantModality":"104", "CedantAssignorCode":"7076568", "CedantMaxOurNumber":"13", "CedantDocumentType":"Escritural", "CedantFeatureTitle":"tcSimples", "CedantTypePortfolio":"tctRegistrada", "CedantName":"ALTERNATE SIST INF LTDA", "CedantCNPJCPF":"68962851000159", "CedantTypeInscription":"pJuridica", "CedantStreetAddress":"RUA ANCHIETA", "CedantAddressNumber":"285", "CedantAddressComplement":"", "CedantNeighborhood":"VL BOAVENTURA", "CedantCity":"JUNDIAI", "CedantState":"SP", "CedantCEP":"13201804" } }], "Succeeded": true}

Boleto - GetPOST api/finance/billetget


Request Formats


Sample:{ "CodeAttendance": "99999", "TitleNumber": "000245631", "CdAccount": "7"

}

19




Sample:{ "Exception": null "Message":null, "Obj":{ "Bank":"033", "CodeAttendance":9999, "CdAccount":7, "CurrentAccountNumber":"013055187", "CurrentAccountNumberDC":"1 ", "Name":"SANTANDER", "TitleNumber":"000245631", "InvoiceNumber":118418, "DueDate":"2016-04-10T00:00:00", "TitleValue":264.59, "InvoiceDate":"2016-03-31T00:00:00", "CardNumber":112, "DraweeName":"ALTERNATE SISTEMAS E INFORMATICA LTDA ", "DraweeStreetAddress":"RUA ANCHIETA,285", "DraweeNeighborhood":"BOAVENTURA", "DraweeCity":"JUNDIAI ", "DraweeCEP":"13201804", "DraweeUF":"SP", "DraweeCNPJCPF":"68962851000159", "Messages":"APOS O VENCIMENTO COBRAR MORA DE R$0,26 AO DIA\nAPOS 10/04/2016 MULTA DE R$5,29\nSUJEITO A PROTESTO SE NAO FOR PAGO NO VENCTO\nCOBRANCA ESCRITURAL.\n", "billetFixedFields":{ "TitleCurrency":"R$", "Agency":"1042-1/7076568", "DigitAgency":"1", "TitleAcceptance":"Não", "TitleDocumentKind":"DS", "TitleOurNumber":"00024563", "CedantModality":"104", "CedantAssignorCode":"7076568", "CedantMaxOurNumber":"13", "CedantDocumentType":"Escritural", "CedantFeatureTitle":"tcSimples", "CedantTypePortfolio":"tctRegistrada", "CedantName":"ALTERNATE SIST INF LTDA", "CedantCNPJCPF":"68962851000159", "CedantTypeInscription":"pJuridica", "CedantStreetAddress":"RUA ANCHIETA",

20


"CedantAddressNumber":"285", "CedantAddressComplement":"", "CedantNeighborhood":"VL BOAVENTURA", "CedantCity":"JUNDIAI", "CedantState":"SP", "CedantCEP":"13201804" } }, "Succeeded": true}

Requestweb – Total de registros da ListaPOST api/requestweb/listtotal

Tela atual: http://www.alternate.com.br/cliente/requestweb/listar.php

Observação: Retorna total de registros para montar a paginação.

Request Formats


Sample:{ "CodeAttendance":"99999"}



Sample:{ "Exception": null "Message":null, "Obj":837, "Succeeded": true}

21

http://www.alternate.com.br/cliente/requestweb/listar.php


Requestweb - ListaPOST api/requestweb/list


Request Formats





Sample:{ "Exception": null "Message":null, "ObjList":[{"CallNumber":273, "StepNumber":5, "StepDescription":"REPROVADO", "StepColor":”#FF0000”, "Subject":"Zanini", "Type":"S", "TypeDescription":"Sugestão", "OpenDate":"2004-05-28T00:00:00", "LastUpdate":"2004-08-26T00:00:00" }, { "CallNumber":274, "StepNumber":5, "StepDescription":"REPROVADO", "StepColor":”#FF0000”, "Subject":"Fracionamento", "Type":"S", "TypeDescription":"Sugestão",

22



"OpenDate":"2004-05-28T00:00:00", "LastUpdate":"2004-06-22T00:00:00" }], "Succeeded": true}

Requestweb - TotaisPOST api/requestweb/total


Request Formats





Sample:{ "Exception": null "Message":null, "ObjList":[{ "StepDescription":"EM ABERTO", "StepColor":"#0000FF", "AmountStep":81 }, { "StepDescription":"DETALHAR", "StepColor":"#008080", "AmountStep":5 },

23



{ "StepDescription":"APROVADO NO SUPORTE", "StepColor":"#FFD000", "AmountStep":59 }, { "StepDescription":"APROVADO NO DESENVOLVIMENTO", "StepColor":"#FF6101", "AmountStep":15 }, { "StepDescription":"FINALIZADO", "StepColor":"#008000", "AmountStep":569 }, { "StepDescription":"REPROVADO", "StepColor":"#FF0000", "AmountStep":94 }, { "StepDescription":"SUGESTÃO FUTURA", "StepColor":"#00BFFF", "AmountStep":10 }], "Succeeded": true}

Requestweb - DetalhePOST api/requestweb/detail

Tela atual: http://www.alternate.com.br/cliente/requestweb/visualizar.php?nchd=00100

Request Formats


24


Sample:{ "CodeAttendance": 99999, "CallNumber": 100}



Sample:{ "Exception": null "Message":null, "Obj":{ "CallNumber":100, "OpenDate":"2004-03-09T00:00:00", "Contact":"ANDRÉ", "SponsorAnalyst":"ANDRE", "System":"Fórmula Certa", "Module":"FCFUNCIONARIOS.EXE", "Subject":"Campo Usuário", "TypeDescription":"Correção", "Description":"O sistema está deixando colocar o mesmo usuário para mais de um funcionário.\nNo DOS quando feito isso ele dá o aviso que já tem um funcionário com aquele usuário que está sendo colocado.", "ContactFooter":"Essa solicitação já foi implementada no sistema. Entre no site e faça o download da última versão ou solicite o seu CD.", "History":[{ "History":2, "StepNumber":2, "Step":"APROVADO NO SUPORTE", "StepColor":"#FFD000", "Comment":"nao deve proibir de colocar, porque muitas vezes o cliente cria um usuario padrao para varias pessoas usarem, porem cabe dar uma mensagem.", "UpdateDate":"2004-03-19T00:00:00" }, { "History":3, "StepNumber":3, "Step":"APROVADO NO DESENVOLVIMENTO", "StepColor":"#FF6101", "Comment":"Porem nao sera feito a verificacao de

25


usuario por usuario, deixaria o processo lento . \n\nMas existira uma CONSULTA por Usuarios, mostrando todos os funcionarios que estao vinculados com X usuario.\n", "UpdateDate":"2004-03-29T00:00:00" }, { "History":4, "StepNumber":4, "Step":"FINALIZADO", "StepColor":"#008000", "Comment":"Meta : Verificacao de funcionarios ligados com o mesmo usuario.\nTeste : \nFora ligados varios usuarios para que trabalhasse com o mesmo usuario. \n\nApos entrar no F5, existe um filtro para pesquisa que possibilita selecionar um Usuario especifico ou Todos os usuarios, a partir dai a pesquisa ira relacionar todos os FUNCIONARIOS que estejam ligados a este USUARIO, alem dos filtros que la ja continham . \n\nEx : Se eu tivesse o seguinte cadastro de funcionarios : \n\nFUNCIONARIO USUARIO\nJulio\t\t\t Caixa\nRafael\t\t\t Caixa\nMariana\t\t\t Balcao\nFabio\t\t\t Entrega\nAdriano\t\t\t Caixa\nNeste exemplo se eu pedisse para filtrar todos os FUNCIONARIOS que tivessem o USUARIO \" CAIXA \", me traria em tela : \n\nFUNCIONARIO USUARIO\nJulio\t\t\t Caixa\nRafael\t\t\t Caixa\nAdriano\t\t\t Caixa\n\n \nNome executavel.............................................. : fcfuncionarios\nDt. do executavel.............................................. : 01/04/2004\nHora do executavel........................................... : 11:20\nVersao do modulo...............................................:1.1.024\nVersaobanco necessario para q o modulo funcione..: >=69\nNecessario tambem os módulos..........................: \n\nProcedimentos : Apenas troca do executavel. Disponivel para envio\n", "UpdateDate":"0001-01-01T00:00:00" }] }, "Succeeded": true

}

Requestweb – Lista de etapasPOST api/requestweb/steps

Tela atual: http://www.alternate.com.br/cliente/requestweb/legenda.php (acesso pelo menu na tela de detalhe).

26

http://www.alternate.com.br/cliente/requestweb/legenda.php


Request Formats


Sample:{}



Sample:{ "Exception": null "Message":null, "ObjList": [{ "StepNumber":1, "Step":"EM ABERTO", "StepColor":"#0000FF", "Description":"Sua chamada foi aberta pelo contato do suporte técnico e, neste momento, está sendo analisada por nossos especialistas.", "Order":1 }, { "StepNumber":6, "Step":"DETALHAR", "StepColor":"#008080", "Description":"Será necessário um melhor detalhamento do problema.", "Order":2 }, { "StepNumber":2, "Step":"APROVADO NO SUPORTE", "StepColor":"#FFD000", "Description":"Sua chamada foi analisada, tem fundamento e precisa ser testada. Agora ela passará para o departamento de testes.\r\n", "Order":3 }, {

27


"StepNumber":3, "Step":"APROVADO NO DESENVOLVIMENTO", "StepColor":"#FF6101", "Description":"Sua chamada passou pelo setor de testes e, em seguida, pelo setor de desenvolvimento que a aprovou. Agora ela está em fase de desenvolvimento.", "Order":4 } ,{ "StepNumber":4, "Step":"FINALIZADO", "StepColor":"#008000", "Description":"Sua chamada passou por todas as etapas e foi finalizada com sucesso. Ela constará no sistema e você será avisado.", "Order":5 },{"StepNumber":5, "Step":"REPROVADO", "StepColor":"#FF0000", "Description":"Sua chamada passou por todas as etapas e foi reprovada. Você será avisado pelo contato que abriu o chamado.", "Order":6 }, { "StepNumber":7, "Step":"SUGESTÃO FUTURA", "StepColor":"#00BFFF", "Description":"Sua sugestão foi aceita e posteriormente poderá fazer parte do sistema.\r\n", "Order":7 }], "Succeeded": true}

Requestweb – Atualização do aviso requestPOST api/requestweb/updateadviceemail

Tela atual: http://www.alternate.com.br/cliente/requestweb/listar.php (Existe um checkbox que aparece nessa tela quando o usuário tem perfil master, serve para marcar se o usuário quer receber avisos de request no email.).

Request Formats


28


Sample:{ "CodeAttendance":99999, "Email":"[email protected]", "Password":"123456", "isAdviceEmail":"true"}




Requestweb – Pegar o cadastro aviso requestPOST api/requestweb/getadviceemail

Tela atual: http://www.alternate.com.br/cliente/requestweb/listar.php (Existe um checkbox que aparece nessa tela quando o usuário tem perfil master, serve para marcar se o usuário quer receber avisos de request no email. Deve ser exibido o valor atual do campo).

Request Formats


Sample:{

"CodeAttendance":99999,

"Email":"[email protected]",

"Password":"123456"

}

29




Sample:{ "Exception": null "Message":null, "Obj":true, "Succeeded": true}

PhoneSupport – Total de registros da ListaPOST api/phonesupport/listtotal

Tela atual: http://www.alternate.com.br/cliente/phonesupport/listar.php

Observação: Retorna o total de registros para montar a paginação.

Request Formats


Sample:{ "CodeAttendance":"99999"

}



30


Sample:{ "Exception": null "Message":null, "Obj":837, "Succeeded": true}

PhoneSupport - ListaPOST api/phonesupport/list

Tela atual: http://www.alternate.com.br/cliente/phonesupport/listar.php

Request Formats





Sample:{ "Exception": null "Message":null, "ObjList":[{ "CallNumber":230933, "ItemId":1, "System":"FORMULA CERTA", "Module":"HARDLOCK",

31


"Subject":"VALIDACAO", "Date":"2004-03-29T00:00:00", "Analyst":"EDEVAL", "Time":"00:00:22" }, { "CallNumber":247705, "ItemId":1, "System":"FORMULA CERTA", "Module":"BACKUP", "Subject":"RESTAURAR", "Date":"2004-07-01T00:00:00", "Analyst":"HOENIR", "Time":"00:13:51" }], "Succeeded": true}

PhoneSupport – Detalhe POST api/phonesupport/detail

Tela atual: http://www.alternate.com.br/cliente/phonesupport/visualizar.php?nrcha=537421&itemid=1

Obs.: Na tela pode haver mais de uma resposta para pergunta em questão.

Request Formats


Sample:{ "CallNumber":537421, "ItemId":1}



32


Sample:{ "Exception": null "Message":null, "Obj":{ "Question":"----- Original Message ----- \r\nFrom: Felipe Augusto Vendrasco \r\nTo: [email protected] \r\nSent: Saturday, February 09, 2008 1:30 PM\r\nSubject: AC/ Marcel\r\n\r\n\r\nBom dia!\r\nsegue em anexo os problemas que estão dando no modulo Caixa do Formula Certa na Hervas de Mauá (Formulatta).\r\n\r\nA 1ª imagem (fcerta1) é sobre o erro que ocorre quando o Pay & Go! já está conectado.\r\n A 2ª e 3ª imagem (fcerta2 e fcerta3) e sobre o erro que ocorre quando o Fomula Certa é inicializado e depois de aberto o Pay&Go! é conectado.\r\n\r\nQualquer duvida entre em contato\r\nFelipe\r\n91729344\r\n\r\n\r\n\r\n--------------------------------------------------------------------------------\r\nAbra sua conta no Yahoo! Mail, o único sem limite de espaço para armazenamento! \r\n\r\n\r\n--------------------------------------------------------------------------------\r\n\r\n\r\n\r\n\r\n\r\n\r\n--------------------------------------------------------------------------------\r\n\r\n\r\n\r\n\r\n\r\n\r\n--------------------------------------------------------------------------------", "Answer": [{ "Answer":"[email protected] <[email protected]>\r\n\r\nA\\C\r\n\r\nFELIPE\r\n\r\n\r\n\r\n\r\n\r\nFelipe Boa Tarde,\r\n\r\nSobre as telas de erros que você me enviou, terá que efetuar o seguinte teste para mim Felipe, abaixo as orientações:\r\n\r\n1º Remover o SAFENET da máquina onde esta instalado em adicionar-remover programas o nome do programa é Sentinel Protection, desligar a máquina, tirar o SAFENET da máquina.\r\n\r\n2º Instalar o SAFENET em outra máquina com o mesmo plugado.\r\n\r\n3º Efetuar testes e se acaso o erro ainda persistir me avisar.\r\n\r\nAtt.\r\nMarcel\r\nSuporte Técnico.", "Analyst":"MARCEL", "Date":"2008-02-11T00:00:00", "Contact":"E MAIL CLIENTE" }] }, "Succeeded": true}

33


PhoneSupport – Avaliação POST api/phonesupport/createrating


Obs.: Inseri avaliação. Só pode haver um registro por CallNumber e ItemId. Se tentar cadastrar mais de uma vez retorna erro. Na tela após cadastrar não permite mais a edição exibe os dados cadastrados(próximo método).

Request Formats


Sample:{

"CodeAttendance":"99999", "Email":"[email protected]", "Password":"123456", "CallNumber":537421, "ItemId":1, "Grade":4, "Util":"true", "Comment":"comentário feito 7"}




34


PhoneSupport – Pegar avaliaçãoPOST api/phonesupport/getrating


Request Formats


Sample:{ "CallNumber":537421, "ItemId":1}



Sample:{ "Exception": null "Message":null, "Obj":{ "CallNumber":537421, "ItemId":1, "Grade":4, "Util":"S", "Comment":"comentário feito 7", "Name":"Rafael", "Email":"[email protected]", "Date":"2016-04-15T00:00:00", "Time":"09:32:41.1779000", "Finished":"N" },"Succeeded": true}

AdmninistrationPOST api/administration/insertuser

35


Tela atual: http://www.alternate.com.br/cliente/usuarios/form.php

Obs.: Inserir um novo usuário.

Request Formats


Sample:{ "CodeAttendance" : 99999, "Name" : "Rodrigo Souza", "Email" : "[email protected]", "Sex" : "M", "Active" : "S", "IpRegister" : "192.168.1.108", "SiteUsersPermissions":[{

"IdModule": 5 },

{ "IdModule": 6 }

]}



Sample:{ "Exception": null "Message":null, "Obj":null, "Message":"Registro inserido com sucesso." "Succeeded": true}

POST api/administration/updateuser

Tela atual: http://www.alternate.com.br/cliente/usuarios/form.php?id=2502

Obs.: Alterar um usuário.

36

http://www.alternate.com.br/cliente/usuarios/form.php?id=2502

http://www.alternate.com.br/cliente/usuarios/form.php


Request Formats


Sample:{ "IdUser": "34", "CodeAttendance" : 99999, "Name" : "Rodrigo Souza", "Email" : "[email protected]", "Sex" : "M", "Active" : "S", "IpRegister" : "192.168.1.108", "SiteUsersPermissions":[{

"IdModule": 5 },

{ "IdModule": 6 }

]}



Sample:{ "Exception": null "Message":null, "Obj":null, "Message":"Registro alterado com sucesso." "Succeeded": true}

POST api/administration/users

Tela: http://www.alternate.com.br/cliente/usuarios/listar.php

Obs.: Listar usuários do máster.

Request Formats


37

http://www.alternate.com.br/cliente/usuarios/listar.php


Sample:{ "CodeAttendance" : 99999}



Sample:{ "Exception": null "Message":null, "ObjList":[{

"IdUser":"1", "Name":"Eduardo Santos", "Email":"[email protected]", "Active":"S",

"Message":null },

{ "IdUser":"2",

"Name":"Nome teste", "Email":"[email protected]", "Active":"S","Message":null

},

{ "IdUser":"3",

"Name":"Rodrigo Souza", "Email":"[email protected]", "Active":"S", "Message":null

},

{ "IdUser":"4",

"Name":"(MASTER) Rafael",

"Email":"[email protected]", "Active":"S",

38


"Message":"Se deseja alterar os dados deste usuário entre em contato com a Alternate."

}], "Success":true}

POST api/administration/user

Tela: http://www.alternate.com.br/cliente/usuarios/form.php?id=2502

Obs.: Detalhe do usuário.

Request Formats


Sample:{ "CodeAttendance" : 99999, "IdUser" : 2}



Sample:{ "Exception": null "Message":null, "Obj":{

"Name": "Rafael Santos Olieveira", "Email": "[email protected]", "Sex": "M", "Active":"S", "SiteModulesModel":[{

39

http://www.alternate.com.br/cliente/usuarios/form.php?id=2502


"IdModule":1, "Module":"Área do Cliente", "Checked":true

},

{ "IdModule":2, "Module":"Alterar Senha", "Checked":true

},

{ "IdModule":3,

"Module":"Legislações", "Checked":true

},

{ "IdModule":4,

"Module":"RequestWeb", "Checked":false },

{ "IdModule":5,

"Module":"Avaliação de Funcionários", "Checked":false

},

{ "IdModule":6,

"Module":"PhoneSupport", "Checked":false

},

{ "IdModule":7, "Module":"Links Úteis", "Checked":false

},

{ "IdModule":8,

"Module":"RequestWeb - Receber notificação por e-mail", "Checked":false

},

40


{ "IdModule":9,

"Module":"Downloads", "Checked":false

},

{ "IdModule":10,

"Module":"ChatSupport", "Checked":false

},

{ "IdModule":11, "Module":"Cursos", "Checked":false

},

{ "IdModule":12,

"Module":"TechnoSupport - Consultar",

"Checked":false },

{ "IdModule":13,

"Module":"TechnoSupport - Fazer pergunta", "Checked":false

},

{ "IdModule":14,

"Module":"Consultar boletos", "Checked":false

}]}, "Success":true}

41


POST api/administration/deleteuser

Obs.: Deletar usuário.

Request Formats


Sample:{ "IdUser": "31",}



Sample:{ "Exception": null "Message":null, "Obj":null, "Message":"Registro deletado com sucesso." "Succeeded": true}

POST api/administration/modules

Tela: http://www.alternate.com.br/cliente/usuarios/form.php

Obs.: Listar modulos para cadastar um novo usuário.

Request Formats


42


Sample:{

}



Sample:{ "Exception": null "Message":null, "ObjList":[{

"IdModule":1, "Module":"Área do Cliente", "Checked":true

},

{ "IdModule":2, "Module":"Alterar Senha", "Checked":true},

{"IdModule":3,"Module":"Legislações","Checked":true

},

{"IdModule":4,"Module":"RequestWeb","Checked":false

},

{"IdModule":5,"Module":"Avaliação de Funcionários","Checked":false

},

{

43


"IdModule":6,"Module":"PhoneSupport","Checked":false

},

{"IdModule":7,"Module":"Links Úteis","Checked":false

},

{"IdModule":8,"Module":"RequestWeb - Receber notificação por e-

mail", "Checked":false

},

{"IdModule":9,"Module":"Downloads","Checked":false

},

{"IdModule":10,Module":"ChatSupport","Checked":false

},

{"IdModule":11,Module":"Cursos","Checked":false

},

{"IdModule":12,"Module":"TechnoSupport - Consultar","Checked":false

},

{"IdModule":13,"Module":"TechnoSupport - Fazer pergunta","Checked":false

},

44


{"IdModule":14,"Module":"Consultar boletos","Checked":false

}],

"Success":true}

POST api/administration/changepassword

Tela:

Obs.: Alterar senha do usuário

Request Formats


Sample:{ "NewPassword" : "123456", "Password" : "654321", "ConfirmPassword" : "123456", "CodeAttendance" : 99999, "Email" : "[email protected]"}



Sample:{ "Exception": null "Message":null, "Obj":null, "Message":"Senha alterada com sucesso! Você precisará efetuar o login novamente!" "Succeeded": true}

45


Chat SupportPOSTapi/chatsupport/products

Tela: http://www.alternate.com.br/chat/custom.php

Obs.: Listar produtos no dropdownlist do campo Produto*.

Request Formats





Sample:{ "Exception": null "Message":null, "ObjList":[{ "CodeSystem":45, "System":"ABFH" }, { "CodeSystem":13, "System":"ATENTO RX" },

{ "CodeSystem":1, "System":"FORMULA CERTA" },

{

46


"CodeSystem":19, "System":"MQS MANIPULACAO" },

{ "CodeSystem":14, "System":"O FORMULISTA" }], "Success":true}

POSTapi/chatsupport/issues


Obs.: Listar produtos no dropdownlist do campo Assunto*.

Listar assuntos no dropdownlist do campo Assunto* de acordo com o produto selecionado.

Request Formats


Sample:{ "CdSystem": 4}



Sample:{ "Exception": null "Message":null, "ObjList":[{ "CdModule":10, "Module":"AGENDAMENTO"

47


}, { "CdModule":4, "Module":"ARQUIVOS" }, { "CdModule":6, "Module":"CALCULOS" }, { "CdModule":1, "Module":"GERAL" }, { "CdModule":5, "Module":"LANCAMENTOS" }, { "CdModule":7, "Module":"RELATORIOS" }, { "CdModule":8, "Module":"UTILITÁRIOS" }], "Success":true}

POST api/customer/detailscustomer


Obs.: Método para obter detalhes do cliente.

Request Formats


48





Sample:{ "Exception": null "Message":null, "Obj":{ "CodeAttendance": "sample string 1", "CompanyName": "sample string 2", "CNPJ": "sample string 3", "Representative": "sample string 4", "Phone": "sample string 5", "Email": "sample string 6", "Fanta": "sample string 7", "FederalUnit" : " sample string 8" }, "Succeeded": true}

49

briefing de implantação omnichannel -...

Documents