{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"fa779b8f-e854-4e78-9b81-72e9bf85a7b2","name":"Api Reqlut","description":"Last update: _August 1st 2019._\n\n{{portal}} has an **API RESTful** that allows your company to create and manage your recruiting and selection processes.\n\nAPI Reqlut uses a **Token** to authenticate your company, wich will give you full access to your company recruiting and selection processes, candidates and all the tools that {{portal}} provides you.\n\n# Environment\n\nFor testing purposes you should use the end point\n\n<a href=\"{{stage-endpoint}}\">{{stage-endpoint}}</a>\n\n. Please contact the administrator if it is outdated.\n\nTo contact the administrator write to\n\n<a href=\"mailto:it@reqlut.com?subject=Api\" reqlut=\"\">it@reqlut.com</a>\n\n.\n\n.\n\n# Company Requirement\n\nCompanies need an active reqlut plan to be able to use the API. For more information [click here](https://reqlut.com/empleadores#pricing)\n\n.\n\n# Overview\n\nAPI Reqlut contains methods to:\n\n<ul><li><p>Create, publish and finish Job Offers.</p></li><li><p>Post Job Offers accross multiple job portals (multiposting).</p></li><li><p>Get applicants information, including the resume and pdf of each applicant.</p></li><li><p>Get lists such as countries, regions, townships, languages, careers, etc...</p></li></ul>\n\n# Authentication\n\nAPI Reqlut uses a **Token** to authenticate your company. This gives full you access to create and manage the recruiting and selection processes of your company, your candidades, and all the functionality of {{portal}}.\n\nTo start using API Reqlut the first thing you need to do is get your company token, in order to do this you need to **log in to your company account** then go to the section **\"Más > Integraciones\"** and there click on **\"Activar API Reqlut\"**, with this the token will be generated.\n\nIf everything went allright your company token should look like this:\n\n```\neyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6IjEiLCJuYW1lIjoiUmVxbHV0IiwidmVyc2lvbiI6MywiY3JlYXRlZEF0IjoiMjAxOS0wNy0yNiAwMjowNTo0MSBVVEMiLCJ1bmlxdWUiOiI2NWVlYTcwOGQyMTFiNTNmYTFlNWFlYTgwMjIxYzg0MTcyYjllN2NhIn0.3VRHCcFL3HRbE_-8dKHcdPWOI4KM7Vwo3XSUZqTJnv4\n\n```\n\nWith this now you have all you need to start using API Reqlut using the following documentation.\n\nAlso you need to add the header User-Agent with the information of the application that is making the requests, it should look like this:  \n**User-Agent : Reqlut-Application/3.0**\n\n# Requests\n\nBelow we show you the way in which you should perform request to API Reqlut.\n\n## Structure\n\nHaving your **company token** to make requests to the API you must structure the request of the query following this instructions:\n\n<p><br><br></p><p><br><br><br></p><table><tbody><tr><th>Parameter</th><th>Description</th></tr><tr><td>Method</td><td>GET, POST or PUT depending on the method you are going to use</td></tr><tr><td>token</td><td>In the header of the request there must be a header named \"token\" and the value of the header must be your company token</td></tr><tr><td>URL</td><td>{{endpoint}} (connections without https are not allowed)</td></tr><tr><td>Parameters</td><td>The parameters must be as specified on each method</td></tr><tr><td>Response</td><td>The information returned by API Reqlut will be allways in <b>JSON</b> format</td></tr></tbody></table>\n\n# Error Codes\n\nWhen there is an error with a request to the API an error code and message will be returned as follows:\n\n## Types of errors\n\nThe request will return a code (HTTP status code) and a message if it applies.\n\n<p><br><br></p><p><br><br><br></p><table><tbody><tr><th>HTTP status code</th><th>HTTP status name</th><th>Description</th></tr><tr><td>400</td><td>Bad request</td><td>There is an error with the parameters sent in the request</td></tr><tr><td>403</td><td>Forbidden</td><td>There is an error with the token sent in the header or you are not authorized to perform the action</td></tr><tr><td>404</td><td>Not found</td><td>The requested url does not exist or an object required to perform the request does not exist</td></tr><tr><td>405</td><td>Method not allowed</td><td>The url you are requesting does not support the method you are using (GET|POST|PUT)</td></tr><tr><td>500</td><td>Internal server error</td><td>Internal server error, please contact the administrator</td></tr></tbody></table>\n\n# Paging\n\nYou can paginate the results of the queries made (for example on GET joboffers). To do this use the parameters **limit** to limit the number of results (size of the page) and **offset** to set the first result to show on the page.  \n  \n  \nAlso the lists response have a custom header **X-Total-Count** wich is the total number of results of the query without including paging.\n\n# Multiposting\n\nSomething important regarding multiposting is that there are **two types of portals allowed for it**, they are identified by the attribute **type** of the portal and this is absolutely essential for requests involving this.\n\n<p><br><br></p><p><br><br><br></p><table><tbody><tr><th>Type</th><th>Description</th><th>Other</th></tr><tr><td>1</td><td>Normal portals that are directly integrated with your company</td><td></td></tr><tr><td>2</td><td>Portals that you must manually connect in order to be able to post jobs to the portal</td><td>This portals offer less information than normal portals, for example you are not able to see how many views or applications have the Job Offer in a particular portal</td></tr></tbody></table>","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"4090317","team":450062,"collectionId":"fa779b8f-e854-4e78-9b81-72e9bf85a7b2","publishedId":"SVYjUNM6","public":true,"publicUrl":"https://documenter-api.postman.tech/view/4090317/SVYjUNM6","privateUrl":"https://go.postman.co/documentation/4090317-fa779b8f-e854-4e78-9b81-72e9bf85a7b2","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"0069D9"},"documentationLayout":"classic-double-column","version":"8.10.1","publishDate":"2019-07-31T20:31:50.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[{"name":"[Docs] Api v3","id":"6a611bc0-851c-4f40-8730-ca976b134fa5","owner":"4090317","values":[{"key":"partner-token","value":"{partner-token}","enabled":true},{"key":"token","value":"{token}","enabled":true},{"key":"endpoint","value":"https://reqlut.com","enabled":true},{"key":"portal","value":"Reqlut","enabled":true},{"key":"jobOfferId","value":"{jobOfferId}","enabled":true},{"key":"jobPortalIntegratorId","value":"{portalId}","enabled":true},{"key":"portalUsername","value":"{portal-username}","enabled":true},{"key":"portalPassword","value":"{portal-password}","enabled":true},{"key":"applicationState","value":"{application-state}","enabled":true},{"key":"userId","value":"{user-id}","enabled":true},{"key":"stage-endpoint","value":"https://stage.reqlut.com","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/b13d2bc3c73a56672762dc1ab8433fd8ad13141eefea0f13111b34beba9a0dcf","favicon":""},"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":"[Docs] Api v3","value":"4090317-6a611bc0-851c-4f40-8730-ca976b134fa5"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/SVYjUNM6"}