{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"26d8de81-541c-4f0b-904e-0048ea351189","name":"CustomerX - Tracking ","description":"É um serviço fornecido pela CustomerX, para que seus clientes possam traquear as ações de usuários em seus softwares.  \n​\n\n## O que eu posso fazer com esta API?\n\n- Trackear telas(screens), ações(actions) e acessos(logins) dos usuários no seu software;  \n    ​\n    \n\n## Como ser atendido se eu tiver dúvidas?\n\n- Abra um chamado enviando um e-mail para:\n    \n    - [suporte@customerx.cx](https://mailto:suporte@customerx.cx)\n- Visite nosso site: [https://customerx.cx](https://customerx.cx)  \n    ​\n    \n\n## Como funciona a API?\n\nPrincipal URL:\n\n- `https://sandbox.tracker.customerx.com.br`\n    \n\nMais informações:\n\n- Sobre API REST - [https://pt.wikipedia.org/wiki/REST](https://pt.wikipedia.org/wiki/REST)\n- Retornos em JSON codificados com Unicode\n- Datas em formato DD/MM/AAAA\n- Números com “.” como separadores decimais, sem separadores milhares e com o sinal “-” representando valores negativos  \n    ​\n    \n\n## Ambientes\n\n> **Atenção:** O ambiente de sandbox é diferente do ambiente de produção a nível de dados salvos e credenciais. \n  \n\n**Ambiente para testes:**\n\n- Sandbox: [https://sandbox.tracker.customerx.com.br](https://sandbox.tracker.customerx.com.br) - \\[Download Postman\\]  \n    ​\n    \n\n**Ambiente de produção:**\n\n- Production: [https://tracker.customerx.com.br](https://tracker.customerx.com.br) - \\[Download Postman\\]  \n    ​\n    \n\n## O que significa da status do retorno HTTP\n\nÉ importante uma correta validação deste status considerando que um valor maior ou igual a `300` sempre representa um erro.  \n​  \nOs status seguem o padrão do HTTP. Os mais comuns da nossa API são:\n\n- O status `202` significa que algo solicitado será processado de forma assíncrona;\n- O status `400` significa que algo fornecido da parte do usuário não corresponde com o esperado;\n- O status `401` significa que algo deu errado com as credenciais que foram fornecidas para a API;\n- O status `403` significa que algo que você está tentando fazer não está disponível para o seu nível de autorização, ou algum recurso ainda não foi liberado para você;\n- O status `500` significa que alguma validação da parte do servidor não ocorreu como planejado na requisição.  \n    ​\n    \n\n## Autenticação no Tracking\n\n- Credential e Key  \n    ​\n    \n\n#### Credential e Key\n\nPara realizar qualquer ação no tracking é necessário informar a `credential` e `key` que é liberada ao criar uma nova conta em nossos ambientes. Estas credenciais identificam sua empresa para que o vinculo dos trackings realizados sejam validos.  \n​\n\n- No menu superior direto Empresa\n- Campo de Credencial\n- Campo de Chave\n    \n\n​\n\n<img src=\"https://customerx-files.s3-us-west-2.amazonaws.com/credential_and_key.png\">","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"3927575","team":166891,"collectionId":"26d8de81-541c-4f0b-904e-0048ea351189","publishedId":"RWgxvFSy","public":true,"publicUrl":"https://doc.tracking.customerx.com.br","privateUrl":"https://go.postman.co/documentation/3927575-26d8de81-541c-4f0b-904e-0048ea351189","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"800185"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"800185"}}]}},"version":"8.10.1","publishDate":"2023-09-05T18:10:54.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[{"name":"Tracking Sandbox","id":"94ecba20-31c6-4f87-839a-623e12f10a99","owner":"3927575","values":[{"key":"credential","value":"123","enabled":true},{"key":"key","value":"123","enabled":true},{"key":"url","value":"https://sandbox.tracker.customerx.com.br","enabled":true}],"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/a45cbbe1465c92623fe74fbe4bae27b7d64fa40fa5d337e7bf1e27e5678c9c05","favicon":"https://res.cloudinary.com/postman/image/upload/v1542660099/team/cnqsfqua5qsfgt298qau.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":"Tracking Sandbox","value":"3927575-94ecba20-31c6-4f87-839a-623e12f10a99"}],"canonicalUrl":"https://doc.tracking.customerx.com.br/view/metadata/RWgxvFSy"}