{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"49057902-25d1-45a1-9a4c-fec630a39f61","name":"Properfy Public REST API","description":"Essa é a v1.4 da documentação da REST API do Properfy ([https://properfy.com.br](https://properfy.com.br)). Qualquer dúvida ou problema, entre em contato conosco pelo e-mail [api@properfy.com.br](https://mailto:api@properfy.com.br) ou diretamente com seu gerente de contas.\n\nPara fazer requisições à nossa API, serão necessários dois dados básicos:\n\n**1\\. A URL de acesso do cliente:**\n\nCada cliente usa um subdomínio próprio para acessar o sistema (ex.: sistema.dominiodaimobiliaria.com.br). Essa é a base das URLs a serem utilizadas nas chamadas ao sistema. A composição básica da URL para as chamadas é o subdomínio do cliente adicionado de \"/api/\", por exemplo, [https://sistema.dominiodaimobiliaria.com.br/api/](https://sistema.dominiodaimobiliaria.com.br/api/)\n\n**2\\. O token de autorização:**\n\nCada usuário tem um token próprio. Para geração do seu token, é necessário enviar os dados de login através da rota \"**Auth**\", mostrada abaixo. No retorno dessa chamada há o campo \"token\", no qual consta o dado a ser salvo e enviado como 'Bearer Token' nas demais rotas.\n\n**Formatos padrão**\n\nDatas: Os campos de data sempre devem ser enviados no formato YYYY-MM-DD\n\nValor: Os campos de valor podem ser enviados sem decimais, caso seja um valor inteiro (ex.: 1000). Quando houver decimais, esses devem ser separados da parte inteira por PONTO (ex.: 1000.55). Caso o separador seja uma vírgula, os valores após a vírgula serão descartados!\n\n**Ambiente de Homologação**\n\nPara chamadas ao ambiente de homologação, conforme demonstrado nas chamadas abaixo, a raiz da URL é: [https://sandbox.properfy.com.br/api/](https://sandbox.properfy.com.br/api/)\n\nTodos os dados do ambiente de homologação são falsos, e podem ser livremente trabalhados para os mais variados testes de CRUD. Periodicamente o banco de dados é restaurado, para que sempre estejam em condições ideais para os testes. Tenha em mente que os dados de seus testes podem, portanto, ser perdidos ao longo do tempo.\n\n**Ordem sugerida de cadastros:**\n\nCaso não esteja familiarizado com a API, seguem abaixo algumas sugestões de ordem dos eventos para agilizar seu desenvolvimento:\n\n1. Antes de cadastrar um contrato, cadastre o imóvel (e portanto os proprietários), os inquilinos, e os possíveis fiadores. Salve os IDs para utilizar no momento do cadastro do contrato.\n    \n2. Proprietários que já foram vinculados a imóveis não podem mais ser deletados, somente baixados.\n    \n3. Imóveis que já foram vinculados a contratos não podem mais ser deletados, somente baixados.\n    \n4. Inquilinos que já foram vinculados a contratos não podem mais ser deletados, somente baixados.\n    \n5. Fiadores que já foram vinculados a contratos não podem mais ser deletados, somente baixados.\n    \n6. Contratos que já foram ativados não podem mais ser deletados, somente rescindidos.\n    \n7. Contratos em modo rascunho (pré-ativação) podem ser deletados.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"23095207","team":3967727,"collectionId":"49057902-25d1-45a1-9a4c-fec630a39f61","publishedId":"VUxNR7hZ","public":true,"publicUrl":"https://dev.properfy.com.br","privateUrl":"https://go.postman.co/documentation/23095207-49057902-25d1-45a1-9a4c-fec630a39f61","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.10.1","publishDate":"2022-08-31T02:52:31.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/5f5b6c7f2dad6e58455463f3667087ecf95e1aa5da488f804db8f4a7186baf29","favicon":"https://properfy.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"}],"canonicalUrl":"https://dev.properfy.com.br/view/metadata/VUxNR7hZ"}