{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"235f7ec8-207f-464b-b7d5-2fcf187748ee","name":"DFranquias - CRM","description":"## Princípios básicos\n\nBem-vindo ao guia de referências da API do DFranquias - CRM. É através desta API que você integra o seu sistema ao nosso. \n\nNossa API é  [REST](https://pt.wikipedia.org/wiki/REST), e todas suas respostas são em  [JSON](http://www.json.org/), no endpoint base:\n\n```\n\nhttps://api.dfranquias.com/v2/\n\n```\n\nA seguir, algumas convenções de nossa API:\n\n# \n\nPaginação\n\nHá muitas rotas de listagem de entidades na API. E em algumas delas é necessário lidar com um sistema de paginação para percorrer todas as instâncias. Esse sistema refere-se aos parâmetros  `count`  e  `page`. Count representa quantos resultados por página deverão ser retornados — se não for informado um valor, o padrão é 10 (O valor máximo permitido é 50). Page é a página a ser retornada e se não for informado um valor, o padrão é 1.\n\n# \n\nAutenticação\n\nSempre que a sua aplicação chama algum de nossos endpoints, você deve passar como forma de autenticação um token [JWT](https://jwt.io), que deve ser gerado através do endpoint:\n```\n\nhttps://api.dfranquias.com/v2/login_check\n\n```\n\nO token deve ser passado no header da requisição.  \n\n## Ambientes de Homologação/Teste e Produção\n\nAmbiente de Homologação/Teste:\n```\n\nhttp://dev.dfranquias.com/v2/\n\n```\nAmbiente de Produção:\n```\n\nhttps://api.dfranquias.com/v2/\n\n```\n\nExemplo de retorno pela API:\n\n```json\n{\n  \"pageCount\": 272,\n  \"itemsPerPage\": 3,\n  \"totalItemCount\": 814,\n  \"currentPage\": \"5\",\n  \"items\": [\n    {\n      \"lead\": \"Fulano de Tal\",\n      \"capitalDisponivel\": \"850000.00\",\n      \"dataCadastro\": \"10-09-2019\",\n      \"etapaAtual\": \"\",\n      \"statusLead\": \"Recém Cadastrado\",\n      \"estado\": \"Pará\",\n      \"responsavel\": \"Fulano de Tal\",\n      \"midia\": \"Facebook\",\n      \"id\": 1,\n      \"percentualProgresso\": 0,\n      \"etapas\": [\n        {\n          \"etapa\": \"Primeiro Contato\",\n          \"status\": \"\",\n          \"terminioPrevisto\": \"13-10-2019\"\n        },\n        {\n          \"etapa\": \"1° Entrevista\",\n          \"status\": \"\",\n          \"terminioPrevisto\": \"13-10-2019\"\n        }\n      ],\n      \"dataPrevistaFinalizacao\": \"13-10-2019\",\n      \"dataInicioProcesso\": \"10-09-2019\"\n    },\n    {\n      \"lead\": \"Fulano de Tal\",\n      \"capitalDisponivel\": \"850000.00\",\n      \"dataCadastro\": \"10-09-2019\",\n      \"etapaAtual\": \"\",\n      \"statusLead\": \"Recém Cadastrado\",\n      \"estado\": \"São Paulo\",\n      \"responsavel\": \"Fulano de Tal\",\n      \"midia\": \"Facebook\",\n      \"id\": 2,\n      \"percentualProgresso\": 0,\n      \"etapas\": [\n        {\n          \"etapa\": \"Primeiro Contato\",\n          \"status\": \"\",\n          \"terminioPrevisto\": \"13-10-2019\"\n        },\n        {\n          \"etapa\": \"1° Entrevista\",\n          \"status\": \"\",\n          \"terminioPrevisto\": \"13-10-2019\"\n        }\n      ],\n      \"dataPrevistaFinalizacao\": \"13-10-2019\",\n      \"dataInicioProcesso\": \"10-09-2019\"\n    },\n    {\n      \"lead\": \"Fulano de Tal\",\n      \"capitalDisponivel\": \"850000.00\",\n      \"dataCadastro\": \"10-09-2019\",\n      \"etapaAtual\": \"\",\n      \"statusLead\": \"Recém Cadastrado\",\n      \"estado\": \"Bahia\",\n      \"responsavel\": \"Fulano de Tal\",\n      \"midia\": \"Facebook\",\n      \"id\": 3,\n      \"percentualProgresso\": 0,\n      \"etapas\": [\n        {\n          \"etapa\": \"Primeiro Contato\",\n          \"status\": \"\",\n          \"terminioPrevisto\": \"13-10-2019\"\n        },\n        {\n          \"etapa\": \"1° Entrevista\",\n          \"status\": \"\",\n          \"terminioPrevisto\": \"13-10-2019\"\n        }\n      ],\n      \"dataPrevistaFinalizacao\": \"13-10-2019\",\n      \"dataInicioProcesso\": \"10-09-2019\"\n    }\n  ]\n}\n```","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"1416162","team":544352,"collectionId":"235f7ec8-207f-464b-b7d5-2fcf187748ee","publishedId":"SVtZtjun","public":true,"publicUrl":"https://documenter-api.postman.tech/view/1416162/SVtZtjun","privateUrl":"https://go.postman.co/documentation/1416162-235f7ec8-207f-464b-b7d5-2fcf187748ee","customColor":{"top-bar":"E93629","right-sidebar":"303030","highlight":"F8750F"},"documentationLayout":"classic-double-column","version":"8.10.1","publishDate":"2019-10-16T20:37:44.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[{"name":"Produção","id":"82f818ad-3a4e-4e19-8ff6-e7e8f36b1253","owner":"1416162","values":[{"key":"url","value":"https://api.dfranquias.com/v2","enabled":true},{"key":"token","value":"eyJhbGciOiJSUzI1NiJ9.eyJ1c2VybmFtZSI6ImJlc3RkYXRhQGRmcmFucXVpYXMuY29tIiwidHlwZSI6IkF.wxDCDjrhSqsPsJ5QhE9VFJ0eOZTfa1vKsJJ2qGW2ooQI0fEbjMjCNZD146TZX4H8HdRkc4zYxmfgbkPmwMTk5_j84ggAeiorKxAj8waDyTd9JXD45KoHp-1M6cGJyzsD5mWUL6PY02tol-VVDKPol7ht4Jyzu9hWyhy1zNRsoWj3sz6p4Th4Fo1Rgb7eN6AjX1c2s3kbm8P4vOu_C845VHFtocRtopQ0s8Ns2iywWdShRBwLhabl2TzwU6rFypV7DVWLBvtnXoeHe5W_k77BtGDI9WGjlIneECcoYmUENYVEeqiT1jqo9eQawi-dwWvCfKyaCQpz5yYjCAKmivk21tRfLBmm3irqM-xLjN-41z1B5x9LXW3OW_CBqBoIlblQUkGrNKV0vh9xuZNCgOXXbiAoFWyqb6IVuz9q9trqthm27b6PN3UstqiLLND0-wB1sD-6B5A8XSVtB6UU5YQEeMoyrD8m20Yf-dwI5RXQO1hOVREMOYeBnqhqWOSrmXLvqtBBw9_4gbMexiNjBc3irwINNyRYLorxCVsN9WdfbeoStJSeBQgMSybXYGQso1BAt5tPTgGTSh1CuErkoHR2sPXhCa96TbWlZZD-NpxvHS84JIU89dzv98H_vRuGtDZKUi95K2n9N_NSvwqxJEB5ZKihZb83gLYyFfuR0567hhI","enabled":true},{"key":"user","value":"fulanodetal@mail.com","enabled":true},{"key":"password","value":"senha0000","enabled":true},{"key":"uuid","value":"asdf-d37a-11e7-a732-120bf9easdf3c706","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/072a420638e42ea0759ac1f6364ebf61f2f83d1f52dcf166d9f9d2788b1f8f1a","favicon":"https://res.cloudinary.com/postman/image/upload/v1571334111/team/ezdtelbqk8zijtpzfzlm.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":"Produção","value":"1416162-82f818ad-3a4e-4e19-8ff6-e7e8f36b1253"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/SVtZtjun"}