{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"a5a00ae2-a799-4a86-a486-202f00262985","name":"API Router Gateway Dotz (Varejo)","description":"\n\nMATERIAL COMPLEMENTAR FIXO\n\n- **04/07/2024**\n \n - **POSDOTZ** - Adicionado limite total de 90 items por troca.\n \n- **09/02/2024****Previsão dos comandos em produção para o dia 19/02/2024**\n \n - **POSCASH - Adicionado novo comando que envia solicitações de acúmulo.**\n \n - **POSUNDO - Adicionado novo comando que envia solicitação de estorno de acúmulo e/ou troca.**\n \n - **POSCANC - Tornou-se um comando obsoleto e deverá ser substituido pelo POSUNDO.**\n \n- **25/08/2023**\n \n - **POSUSER - Adicionado novo campo para identificar um limite mínimo para trocas váriaveis, atualização de exemplos.**\n \n - **POSDOTZ - Adicionado informação de limite mímino para troca variável, adição de exemplo.**\n \n- **02/08/2023**\n \n - **Inseridas chamadas de Acúmulo para Incentivos (STDCRED)**\n \n- **28/07/2023**\n \n - **Adicionado mais exemplos de cenários de trocas usando Dotz Parcela.**\n \n- **13/07/2023**\n \n - **Clientes sem contato para realizar autenticação podem realizar troca até atingir limites configurado por parceiro.**\n \n - **Adicionado algumas informações nos retornos do comandos POS.**\n \n- **15/06/2023**\n \n - Material Complementar\n \n **detalhes de como realizar o segundo saldo e da obrigatóriedade da mensageria Dotz no PDV**\n \n- **14/06/2023:**\n \n - **Inserido na chamada** _**4.2**_ **saldo adicional (obrigatório caso retorne)**\n \n - **Inserido na chamada** _**4.3**_ **resgate usando saldo adicional**\n \n - **Inseridos detalhes de como realizar resgate com segundo saldo**\n \n- **26/05/2023**\n \n - **Adicionado novo comando POSCANC**\n \n- **20/04/2023**\n \n - **Adicionado exemplos de requisições para os camandos POSLIVE, POSUSER, POSDOTZ e POSAUTH**\n \n- **05/04/2023**\n \n - **Retorno da chamada de resgate exigindo autenticação**\n \n - Material Complementar\n \n\n---\n\n---\n\n# **1\\. Objetivo**\n\n**Este documento possui o objetivo de descrever o processo de integração com a Dotz, utilizando o router gateway bem como o processo de autenticação e o padrão de envio de recebimento de informações.**\n\n**As informações contidas neste documento podem ser atualizadas a qualquer momento por outros times, não sendo de responsabilidade do squad de entrega atualizar este documento.**\n\n# **2\\. Entendimento de Jornada**\n\nA documentação é dividida entre:\n\n- **Chamadas para Varejo (Autenticação, acúmulo e resgates)**\n \n - Comandos POSUSER, POSDOTZ, POSAUTH, POSCANC\n \n- **Chamadas para Incentivos (Acúmulo)**\n \n - Comando DEPCRED\n \n\n# **2.1 Fluxograma Base**\n\n**\n\n\n\n##### _**IMPORTANTE**_**!**\n\n\\*_Para entender mais sobre os fluxos e ver um exemplo de jornada, clique aqui e veja o documento apendice 1._\n\n#### [>>DOWNLOAD <<](https://)\n\n---\n\n# 3\\. Autenticação e Criptografia - Requests\n\nPara realizar a requisição à api é necessário realizar a criptografia dos dados e seguir um padrão de contrato.\n\n## Pré-requisitos\n\nA Dotz irá fornecer um certificado (pfx) com uma senha, sendo um certificado para ambiente de homologação e um certificado para o ambiente de produção. Toda a mensagem trafegada entre a Dotz e o parceiro deverá conter o certificado na conexão.\n\nTambém serão fornecidas credenciais (clientId + secret) que deverão ser passadas em um header de autenticação basic em todas as mensagens.\n\n****Todos os processos que serão apresentados nos próximos capítulos consideram que todas as formatações estão em UTF 8.**\n\n## Urls\n\n- Homologação: [https://uat-loyalty.dotznext.com/integration-router/api/default/v1/command](https://)\n \n- Produção: [https://loyalty.dotz.com.br/integration-router/api/default/v1/command](https://)\n \n\n## Contrato de Request\n\nPara realizar a requisição para a api todos os comandos são realizados para o mesmo endpoint é nosso router é encarregado de direcionar para o serviço correto.\n\nPara todas as chamadas é necessário passar no header o identificador de parceiro e as credenciais encriptadas.\n\n| **Header Request (http Header)** |\n| --- |\n\n| ID | String | CNPJ da Loja |\n| --- | --- | --- |\n| Content-Type | String | application/json; charset=utf-8 |\n| Authorization | String | Basic {Base64(clientId:secret)} |\n\nExemplo de um Header utilizado\n\n\n\nPara realizar a requisição para a api todos os comandos são realizados para o mesmo endpoint e nosso router é encarregado de direcionar para o serviço correto.\n\n| **Request Body** |\n| --- |\n\n| Data | JSON | |\n| --- | --- | --- |\n\nExemplo de um request body.\n\n\n\nNo campo de Data no Request Body temos o comando no seguinte contrato:\n\n| **Comando - Body Request** |\n| --- |\n\n| Route | String | Identificação do comando (Ref. Comandos possíveis ) |\n| --- | --- | --- |\n| Input | JSON | Dados para requisição |\n\nDentro do campo **Input** é onde estão as informações necessárias para executar o comando.\n\n# 4\\. Comandos\n\n| Comando | Descrição |\n| --- | --- |\n| POSLIVE | Comando utilizado para testar o certificado e as credenciais. |\n| POSUSER | Comando utilizado para realizar a listagem dos dados do comprador (Nome, saldos, produtos, informações de conta, etc). |\n| POSDOTZ | Comando para realizar o resgate de Dotz, usando um SKU e, podendo ser necessário posteriormente utilizar o comando **POSAUTH** para autorização do resgate Dotz. |\n| POSAUTH | Comando que realiza a confirmação da autenticação e finalização de resgate de Dotz. |\n| POSCASH | Comando que realiza uma solicitação de acúmulo. |\n| POSUNDO | Comando que estorna uma troca ou/e um acúmulo realizado. |\n| POSCANC | Comando de estorno do resgate Dotz |\n| STDCRED | Comando de acumulo de Dotz simplificado **para INCENTIVOS** |\n\n## Comandos de Resgate\n\nNesta seção descreveremos sobre os comandos que serão responsáveis por identificar cada operação e este deve conter os campos necessários.\n\nO Campo “data” da request deve conter o seguinte formato JSON:\n\n``` json\n{\n \"data\": \n {\n \"route\": \"ID DO COMANDO\"\n \"input\": \n {\n \"Campo1\": \"String\",\n \"Campo2\": Integer,\n }\n }\n}\n\n ```\n\nStartFragment\n\nO Campo “data” do response será onde retornará os dados. \nEm caso de sucesso:\n\nEndFragment\n\n``` json\n{\n \"data\": \n { \n ... \n }\n}\n\n ```\n\nEndFragment\n\nEndFragment\n\n**","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"5095160","team":1123970,"collectionId":"a5a00ae2-a799-4a86-a486-202f00262985","publishedId":"2s93RZLpKD","public":true,"publicUrl":"https://documenter-api.postman.tech/view/5095160/2s93RZLpKD","privateUrl":"https://go.postman.co/documentation/5095160-a5a00ae2-a799-4a86-a486-202f00262985","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-single-column","customisation":null,"version":"8.11.6","publishDate":"2023-04-06T11:20:34.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/5bd234ed9aa54695b7793d286a5fc912a07ade42175f47ecbfaee1a3476b4931","favicon":"https://res.cloudinary.com/postman/image/upload/v1680779563/team/badtbctv3yxj6sdckd8h.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/2s93RZLpKD"}