O WAbiz Believery é uma plataforma onde qualquer estabelecimento de qualquer segmento pode oferecer seus produtos por meio de um aplicativo personalizado com a sua marca para seus clientes. Com um aplicativo personalizado os estabelecimentos têm um poderoso canal de captação de pedidos e de divulgação.\nEsta plataforma foi concebida para ser apenas um canal de captação de pedidos com algumas opções para interação com o usuário. Toda a gestão interna após o recebimento do pedido pode ser feita pelo próprio estabelecimento através de seu sistema de gestão local. A partir do recebimento do pedido, o atendente transcreve-o manualmente em seu sistema local.
\nPor esta razão, visando proporcionar um processo mais otimizado entre as partes ( pedidos via aplicativo e sistema de gestão local), desenvolvemos uma API que facilita a comunicação entre as mesmas.
\nFoi criada uma WebAPI RESTFul com autenticação via Token.
\nA primeira coisa a se fazer é “Recuperar o Token” informando o usuário e senha que forneceremos para cada estabelecimento quando for habilitada a integração. Este Token dura 24 horas e deve ser renovado caso expire (No caso, basta chamar novamente o método que recupera o token).
\nCom o token armazenado basta fazer as chamadas para o método que traz os “Pedidos Pendentes”. É recomendado que as consultas de pedidos pendentes sejam feitas pelo menos a cada 30 segundos.
\nCada vez que a consulta trouxer pedidos, o sistema local deve então processá-los e confirmar o recebimento dos mesmos, assim como alterar seus status e opcionalmente notificar o cliente em cada fase do processo (por exemplo, informar ao cliente final que o pedido dele já saiu para entrega) - “Status do Pedido”.
\nPara que a integração funcione perfeitamente é preciso que os produtos cadastrados do lado do Aplicativo estejam chaveados com os códigos dos sistema a integrar, assim como as formas de pagamento.
\nEste procedimento é feito pelo nosso Painel de Configurações, onde se gerencia todo o conteúdo do aplicativo.
\nEndereço: https://appmanager.wabiz.com.br
A WAbiz disponibiliza um ambiente (Aplicativo, Painel de Pedidos, Painel de Configurações) para que os desenvolvedores possam realizar suas implementações e testes a partir dos seus dados.
\nEste ambiente é provisionado pela equipe técnica da WAbiz e deve ser solicitado com antecedência.
\nO aplicativo de testes pode ser baixado na Play Store ou na App Store.
\nA equipe da WAbiz vai determinar em qual unidade o desenvolvedor deve trabalhar.
\nÉ por este painel que se visualiza os pedidos via aplicativo.\nEndereço: https://pedidos.wabiz.com.br
O usuário e senha serão informados pela equipe da WAbiz
Caso sua empresa deseja integrar seu Sistema com o Aplicativo da WAbiz, entre em cotato com comercial@wabiz.com.br para que possamos estreitar o relacionamento e então obter os dados para acesso ao API.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Como funciona?","slug":"como-funciona"},{"content":"Para começar...","slug":"para-comecar"},{"content":"Testes e Homologação","slug":"testes-e-homologacao"}],"owner":"2422600","collectionId":"fbb1d5d9-1f79-4c5d-8b61-e3e0dccec30d","publishedId":"RVnWhJf2","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"6EA642"},"publishDate":"2018-03-20T16:57:57.000Z"},"item":[{"name":"Endereço da API","item":[],"id":"41f4e536-4fc3-4467-a4ff-42f838804e5d","description":"https://delivery.wabiz.com.br/\nAbaixo estão sendo especificados os campos imporantes para a integração:
\norderNumber (int): Número \"amigável\" do Pedidostatus (int): Status do Pedido (Veja a lista em Status dos Pedidos)internalKey (string): Código Interno do Pedido no aplicativo. obs (string ou null): Observação geral do Pedido.customer (objeto): Estrutura de dados que represanta o Cliente que está pedindoitems (objeto[]): \"Grupo de Produtos\" do Pedido. Em cada grupo temos:products (objeto[]): Produtos escolhidos pelo Clienteqty (int): Quantidadeprice (double): Preço do Produto (para 1 unidade)parts (objeto[]): Frações do Produto. Caso tenha apenas um item na coleção, é um produto Inteiro ou Não Fracionado. Caso tenha mais de um item, por exemplo, dois, seria um produto meio-a-meio e assim por diante.price (double): Valor do Produto no Aplicativo (apenas para conferência)externalCode (string): Código do Produto no Sistema Localcustomization (objeto ou nulo): Customização do Produto. Há 3 tipos de customização:additionals (objeto[]): Itens adicionais do pedido (Complementos, ex: bacon, cebola, milho etc)edge (objeto): Objeto que represanta Borda (para os casos de pizza)others (objeto[]): Configurações extras de um produto (Ex: Tipo de massa)options). Estas opções são compostas por um externalCode (string) com o código de referenência do Sistema Local e price (double) para informar o preço que foi praticado pelo aplicativo.obs (string ou null): Observação da Fraçãoservice (objeto): Objeto com informações sobre o tipo de serviço prestado (Saiba mais logo abaixo)total (double): Total do Pedido,discounts (double): Valor de algum desconto (se houver)A estrutura do objeto que traz informações para o tipo de serviço (service) tem uma propriedade type (string).
Pelo aplicativo é possível fazer pedidos para:
\ntype: delivery
Quando Delivery, é retornado também uma estrutura com os dados de endereço e pagamento:
\ndelivery (objeto)address (string): Logradouronumber (string): Númerocompl (string ou null): Complementoregion (string): BairropostalCode (string): CEPcity (string): Cidadestate (string): UFtax (double): Valor da Taxa de EntregareferencePoint (string ou null): Ponto de Referênciapayment (objeto): Informações do Pagamentotype (int): Tipo de pagamento,value (double): Valor Pago (Para poder calcular troco, se houver),externalCode (string): Código para identificação do tipo de pagamento no Sistema LocalcardFlag (string): Nome da Bandeira/Tipo do cartão (Somente para opção de Maquininha, type = 3)DinheiroChequeMaquininhaPagamento Online (em breve mais detalhes)Boleto (Em breve mais detalhes)Transferência BancáriaPixtype: pickup
type: internal_delivery
Para estabelecimentos que funcionam e entregam numa empresa, shopping, condomínio etc.
\nQuase da mesma forma que o tipo de serviço Delivery, é retornado também uma estrutura com o local da entrega e informações de pagamento:
\ninternalDelivery (objeto)info (string): Local da entregapayment (objeto): Informações do Pagamentotype (int): Tipo de pagamento (idem ao Delivery),value (double): Valor Pago (Para poder calcular troco, se houver),externalCode (string): Código para identificação do tipo de pagamento no Sistema Localtype: table
Além do type, a estrutura conta com tableCode, com o código da mesa e tablePassword, com uma senha que o estabelecimento pode definir para criar uma variação de códigos.
Este recurso pode funcionar de forma adaptada, como comanda.
\ntype: schedule
Este recurso é para o usuário final agendar o horário que deseja obter seu produto no estabelecimento (ex: ele pede um prato e diz que vai estar no estabelecimento as 18h30. Ao chegar, o prato já está pronto e ele já tem sua reserva de mesa)
\nNesta mesma estrutura é retornada o horário em formato de data no campo datetime (yyyy-MM-dd hh:mm:ss)
type: scheduleOrder_delivery
Segue o mesmo padrão do serviço de Delivery, mas tem um campo informando a data e horário para entrega scheduleDatetime (yyyy-MM-dd hh:mm:ss)
type: scheduleOrder_pickup
Segue o mesmo padrão do serviço de Retirada, mas tem um campo informando a data e horário para entrega scheduleDatetime (yyyy-MM-dd hh:mm:ss)
Nos exemplos aqui descritos temos alguns cenários para explorar mais as variações dos pedidos.
\nNo exemplo Delivery, temos um pedido simples de uma pizza normal e dois refrigerantes para entrega.
No exemplo Retirada no Balcão, o pedido é de duas pizzas diferentes, uma inteira com adicionais e bordas e outra meio-a-meio com adicionais, bordas e tipo de massa para retirada no balcão.
O retorno deste método é uma coleçao (Array) com os pedidos.
\n","event":[{"listen":"prerequest","script":{"id":"8ba656ee-712e-49f0-8e8c-5bb6bcf204c7","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"db52f148-409c-4861-8c9b-ee56e13a4617","type":"text/javascript","exec":[""]}}],"_postman_id":"b688bd6d-0966-4fbd-960c-09f6cefad82c","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fbb1d5d9-1f79-4c5d-8b61-e3e0dccec30d","id":"fbb1d5d9-1f79-4c5d-8b61-e3e0dccec30d","name":"WABiz Believery - Integração","type":"collection"}}},{"name":"Status dos Pedidos","item":[{"name":"api/v1/orders/status","id":"c93dabf5-1996-43d1-90e9-000ca84a1274","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer --TOKEN--"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"orderNumber","value":"(int) Número do Pedido","type":"text"},{"key":"internalKey","value":"(string) Código Interno do Pedido","type":"text"},{"key":"newOrderStatus","value":"(int) Status do Pedido","type":"text"},{"key":"sendNotification","value":"(bool [true | false]) Envia notificação","type":"text"},{"key":"additionalMessage","value":"(string) Mensagem adicional (ou em branco para nada)","type":"text"},{"key":"isProcessed","value":"(bool [true | false]) Se o pedido foi ou não processado localmente","type":"text"}]},"url":"https://delivery.wabiz.com.br/api/v1/orders/status","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fbb1d5d9-1f79-4c5d-8b61-e3e0dccec30d","id":"fbb1d5d9-1f79-4c5d-8b61-e3e0dccec30d","name":"WABiz Believery - Integração","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","orders","status"],"host":["delivery","wabiz","com","br"],"query":[],"variable":[]}},"response":[{"id":"7db3490b-e5a7-44a1-9733-f8a025dd8c17","name":"200 OK","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer --TOKEN--"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"orderNumber","value":"3385","type":"text"},{"key":"internalKey","value":"881e7313-6efe-b0a2-a56e-5e14e2a29719","type":"text"},{"key":"newOrderStatus","value":"2","type":"text"},{"key":"sendNotification","value":"true","type":"text"},{"key":"additionalMessage","value":"Aqui pode ir uma mensagem qualquer!","type":"text"},{"key":"isProcessed","value":"true","type":"text"}]},"url":"https://delivery.wabiz.com.br/api/v1/orders/status"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"117","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Mon, 19 Mar 2018 19:39:18 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Request-Context","value":"appId=cid-v1:207f52f7-9967-42bf-b6e4-b47b57397ff1","name":"Request-Context","description":"Custom header"},{"key":"Server","value":"Microsoft-IIS/10.0","name":"Server","description":"A name for the server"},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"},{"key":"X-SourceFiles","value":"=?UTF-8?B?RDpcUHJvamV0b3NcV0FCaXpcV0FCaXouRGVsaXZlcnlcTWFpblxXQUJpei5EZWxpdmVyeS5BUElcYXBpXHYxXG9yZGVyc1xzdGF0dXM=?=","name":"X-SourceFiles","description":"Custom header"}],"cookie":[],"responseTime":null,"body":"{\"success\":true,\"object\":null,\"message\":{\"message\":\"Status do pedido alterado com sucesso!\",\"code\":0,\"details\":null}}"},{"id":"b3bb824f-7bed-4a65-94ef-06b8af0a5c10","name":"404 Not Found","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer --TOKEN--"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"orderNumber","value":"3386","type":"text"},{"key":"internalKey","value":"781e7313-6efe-b0a2-a56e-5e14e2a29719","type":"text"},{"key":"newOrderStatus","value":"2","type":"text"},{"key":"sendNotification","value":"true","type":"text"},{"key":"additionalMessage","value":"Aqui pode ir uma mensagem qualquer!","type":"text"},{"key":"isProcessed","value":"true","type":"text"}]},"url":"https://delivery.wabiz.com.br/api/v1/orders/status"},"status":"Not Found","code":404,"_postman_previewlanguage":"plain","header":[{"key":"Content-Length","value":"0","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Date","value":"Mon, 19 Mar 2018 19:40:23 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Request-Context","value":"appId=cid-v1:207f52f7-9967-42bf-b6e4-b47b57397ff1","name":"Request-Context","description":"Custom header"},{"key":"Server","value":"Microsoft-IIS/10.0","name":"Server","description":"A name for the server"},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"},{"key":"X-SourceFiles","value":"=?UTF-8?B?RDpcUHJvamV0b3NcV0FCaXpcV0FCaXouRGVsaXZlcnlcTWFpblxXQUJpei5EZWxpdmVyeS5BUElcYXBpXHYxXG9yZGVyc1xzdGF0dXM=?=","name":"X-SourceFiles","description":"Custom header"}],"cookie":[],"responseTime":null,"body":""},{"id":"bdbcf2ef-cc97-49b3-9b08-6a15a171cec4","name":"400 Bad Request","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer --TOKEN--"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"orderNumber","value":"3385","type":"text"},{"key":"internalKey","value":"881e7313-6efe-b0a2-a56e-5e14e2a29719","type":"text"},{"key":"newOrderStatus","value":"2","type":"text"},{"key":"sendNotification","value":"true","type":"text"},{"key":"additionalMessage","value":"Aqui pode ir uma mensagem qualquer!","type":"text"},{"key":"isProcessed","value":"true","type":"text"}]},"url":"https://delivery.wabiz.com.br/api/v1/orders/status"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"35","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Mon, 19 Mar 2018 19:41:54 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Request-Context","value":"appId=cid-v1:207f52f7-9967-42bf-b6e4-b47b57397ff1","name":"Request-Context","description":"Custom header"},{"key":"Server","value":"Microsoft-IIS/10.0","name":"Server","description":"A name for the server"},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"},{"key":"X-SourceFiles","value":"=?UTF-8?B?RDpcUHJvamV0b3NcV0FCaXpcV0FCaXouRGVsaXZlcnlcTWFpblxXQUJpei5EZWxpdmVyeS5BUElcYXBpXHYxXG9yZGVyc1xzdGF0dXM=?=","name":"X-SourceFiles","description":"Custom header"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Alguma mensagem sobre o problema encontrado!\"\n}"}],"_postman_id":"c93dabf5-1996-43d1-90e9-000ca84a1274"}],"id":"1c84a38e-ee3c-4934-b974-a5f99683cbf0","description":"O pedido via aplicativo pode ter o seguintes status:
\nAo receber o pedido via API e se o Sistema Local conseguir processá-lo corretamente, o mesmo deve ser Confirmado (status: 2) e com o valor para isProcessed igual a true. Caso o Sistema Local por qualquer motivo não consiga fazer a inclusão do pedido, o mesmo deve ser atualizado, mantendo o status inicial Não Confirmado (status: 1), mas com a propriedade isProcessed igual a false. Isso faz com que o Painel de Pedidos da WAbiz sinalize o pedido na lista como não processado (destacado em tons de vermelho) e emita um som de alerta para o atendente poder avaliar e prosseguir com o atendimento do pedido manualmente.
Para o status de Finalizado (status: 6) é recomendado que o cliente não receba nenhuma notificação (sendNotification=false), pois este processo é feito geralmente ao fechar o caixa ou num momento que o cliente não precisa ser notificado.
Em breve.
\n","event":[{"listen":"prerequest","script":{"id":"100094e6-83bd-46ab-bf13-834a4233ae2f","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"5fed6c7d-f62c-44e4-9a7f-aa817f16362b","type":"text/javascript","exec":[""]}}],"_postman_id":"0f5f46ab-b6ba-453b-b7b1-96b381dd43cb","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fbb1d5d9-1f79-4c5d-8b61-e3e0dccec30d","id":"fbb1d5d9-1f79-4c5d-8b61-e3e0dccec30d","name":"WABiz Believery - Integração","type":"collection"}}},{"name":"Cadastro de Produtos","item":[],"id":"a4811995-963a-45ae-9119-861351a86bc2","description":"Em breve.
\n","event":[{"listen":"prerequest","script":{"id":"85350572-3d00-4ec8-98cc-97078265c5ee","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"0ce0f685-0064-4abf-bc64-bc71f9bef357","type":"text/javascript","exec":[""]}}],"_postman_id":"a4811995-963a-45ae-9119-861351a86bc2","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fbb1d5d9-1f79-4c5d-8b61-e3e0dccec30d","id":"fbb1d5d9-1f79-4c5d-8b61-e3e0dccec30d","name":"WABiz Believery - Integração","type":"collection"}}},{"name":"Suporte e Contato","item":[],"id":"3ac61ff0-92a8-40e1-b7b1-6f586606a800","description":"Para mais informações ou auxílio na integração, envie nos um e-mail para dev@wabiz.com.br ou adicione nosso responsável técnico pelo Skype: arzanardi