{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"8ae011ca-1d27-4a87-993d-4d8c9a7417e0","name":"Documentação Técnica - Passaporte do Apostador","description":"## 👋 Começando com o Passaporte do Apostador\n\nEssa documentação irá lhe ajudar a fazer a integração com o passaporte do apostador.\n\nPara começar a utilizar nossos serviços é necessário conhecer nossas formas de integração e o que nosso produto oferece.\n\nResumidamente, oferecemos o uso de nossas APIs e, caso prefira, você pode se integrar ao seu próprio servidor de autenticação (SSO) utilizando os protocolos SAML ou OAuth 2.0, tendo o passaporte do apostador como identity provider.\n\n## 🚀 Ambientes\n\nAtualmente contamos com dois ambientes disponíveis para utilização.\n\n> **Homologação** \n  \n\nÉ uma sandbox. Um ambiente onde você pode realizar testes e identificar se está apto a migrar sua aplicação para produção.\n\nPor ser um ambiente de testes, ele não irá retornar informações que podem ser utilizadas para tomada de decisões, não gerará nenhum tipo de cobrança e, tão pouco, possui infraestrutura adequada para suportar um volume de transações de operações reais.\n\nUtilize este ambiente com moderação. Para não impactar demais usuários que estão realizando testes, qualquer abuso de volumetria pode resultar em um bloqueio temporário da sua conta.\n\n> **Produção** \n  \n\nÉ o ambiente final onde você deverá direcionar sua aplicação.\n\nAo utilizar este ambiente você estará sujeito a cobranças conforme o seu contrato.\n\n## **⭐️** Credenciais de acesso e integração\n\nPara começar a integração do seu sistema com o Passaporte do apostador, primeiramente você deve estar em posse das credenciais de acesso do ambiente de Homologação.\n\nO contato da sua empresa cadastrado como responsável técnico receberá um e-mail de boas vindas, contendo essas credenciais.\n\nCaso você não tenha recebido as credenciais, entre em contato com o executivo comercial da conta da sua empresa para que seja providenciado ou com [suporte.passaporte@clear.sale](https://mailto:suporte.passaporte@clear.sale) informando o seu CNPJ e Razão Social.\n\n> **Obs.: Qualquer utilização realizada em Produção, entra para o sistema de faturamento, então utilize primeiramente, até a validação dos testes de integração, as credenciais de homologação.** \n  \n\nNosso processo de integração consiste em oferecer a cada entidade cliente um conjunto de credenciais único, armazenado de maneira anonimizada em nossas bases, respeitando a privacidade de seus titulares e as boas práticas de segurança.\n\nAlém disso, também aplicamos uma configuração de restrição de IP em nossos serviços para que somente um escopo conhecido de endereços cadastrados possa ter seu acesso garantido.\n\nEm produção é necessário realizar previamente o cadastros dos IPs e devido a esta camada de segurança, toda a integração com a nossa API deve ser feita via Backend.\n\nQuando estiverem prontos para a entrada em produção, utilizar as credenciais de produção que foram enviadas, mas antes, envie para o e-mail [suporte@clear.sale](https://mailto:suporte@clear.sale) os IPs de Saída do servidor que origina as requisições para a ClearSale para que possamos cadastrá-los em nossa Goodlist.\n\n## 🚀Jornada do usuário\n\n**1\\. Entrada do CPF e telefone**: O apostador insere seu CPF e telefone.\n\n<img src=\"https://content.pstmn.io/f50e1d25-4c40-47d4-88c4-7b9ab290c536/VGVsYSAxLnBuZw==\" width=\"215\" height=\"579\">\n\n**2\\. Validação do token:** O apostador reliza a confirmação do token enviado para o número de celular do cadastro.\n\n<img src=\"https://content.pstmn.io/b3ce8f62-8bc7-45ad-a9eb-b924eeea77a0/VGVsYSBUb2tlbi5wbmc=\" width=\"211\" height=\"385\">\n\n**3\\. Validação Biométrica:** Captura de selfie para validação da identidade.\n\n<img src=\"https://content.pstmn.io/1887aa6f-ae50-4b23-97d0-f5d1907cab94/VGVsYSAyLjEucG5n\" width=\"213\" height=\"425\">\n\n<img src=\"https://content.pstmn.io/0b8335df-2d34-4591-bee1-dbb29fb5655a/VGVsYSAyLjIucG5n\" width=\"209\" height=\"413\">\n\n**4\\. Validação do documento:** Captura, análise e armanagem do documento válido (aceitos pela SPA/MF 1.231).\n\n<img src=\"https://content.pstmn.io/3c41bf07-fe77-4d3a-8b4e-a6160108e0c8/VGVsYSAzLnBuZw==\" width=\"225\" height=\"410\">\n\n<img src=\"https://content.pstmn.io/b4daca41-12f7-47ae-9fc6-9ffa939d621c/VGVsYSBEb2N1bWVudG8ucG5n\" width=\"225\" height=\"411\">\n\n**5\\. Validação da credencial:** O apostador faz a validação e edição (se necessário) dos dados das credenciais.\n\n<img src=\"https://content.pstmn.io/10c075c2-209b-427f-afdd-7df16501dc5a/RGFkb3MgZGFzIGNyZWRlbmNpYWlzLnBuZw==\" alt=\"\" height=\"1066\" width=\"223\">\n\n**6\\. Criação da senha:** O apostador cria a sua senha de acesso de acordo com os critérios de segurança.\n\n<img src=\"https://content.pstmn.io/89bc1e1c-2ba6-47ee-9111-049d10b70061/VGVsYSA1LnBuZw==\" width=\"225\" height=\"536\">\n\n## 🛟 Help and support\n\nSe precisar de assistência durante a integração ou tiver dúvidas sobre o processo de autenticação, entre em contato com nossa equipe de suporte técnico através do e-mail: [suporte.passaporte@clear.sale](https://mailto:suporte.passaporte@clear.sale).","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"32572818","team":1271651,"collectionId":"8ae011ca-1d27-4a87-993d-4d8c9a7417e0","publishedId":"2sAXxPBYsy","public":true,"publicUrl":"https://doc.passaportedoapostador.com.br","privateUrl":"https://go.postman.co/documentation/32572818-8ae011ca-1d27-4a87-993d-4d8c9a7417e0","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-single-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"system_default","themes":[{"name":"dark","logo":"https://content.pstmn.io/d0aca8e7-0ca1-4e0c-a625-1dfad1ee9088/bG9nby1iZXRzLnBuZw==","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":"https://content.pstmn.io/d0aca8e7-0ca1-4e0c-a625-1dfad1ee9088/bG9nby1iZXRzLnBuZw==","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.10.1","publishDate":"2024-10-17T16:53:56.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":"https://content.pstmn.io/d0aca8e7-0ca1-4e0c-a625-1dfad1ee9088/bG9nby1iZXRzLnBuZw==","logoDark":"https://content.pstmn.io/d0aca8e7-0ca1-4e0c-a625-1dfad1ee9088/bG9nby1iZXRzLnBuZw=="}},"statusCode":200},"environments":[{"name":"Homolog","id":"f1458bbc-2235-4510-bb31-1f05a4ef3a87","owner":"32572818","values":[{"key":"apikey","value":"","enabled":true,"type":"secret"},{"key":"baseUrl","value":"staging-id.cpqd.com.br","enabled":true,"type":"default"}],"published":true}],"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/c918d7dd28cea4295712b4a1c5e4d9e1db238a5ce39ad20e78c630d3639410bd","favicon":"https://passaportedoapostador.com.br/favicon.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"},{"label":"Homolog","value":"32572818-f1458bbc-2235-4510-bb31-1f05a4ef3a87"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/2sAXxPBYsy"}