{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"179dc035-4f20-49c0-8589-3cba6bf9ea1e","name":"PXSOL Public API","description":"The **Pxsol Public API (API v2)** enables authorized external systems to interact with Pxsol services, including hotel content, reservations, availability, rates, accounting documents, reports, and conversations.\n\n# Getting Started\n\nAPI access is enabled and managed directly from your Pxsol account. You do **not** need to request an API key by email.\n\n> **Price:** Enabling the integration costs **USD 50 per month, per company**. The charge applies separately to every company where the **Integraciones Generales (API Keys)** module is installed. The applicable terms and charge are displayed for acceptance before installation.\n\n## 1. Install the API Keys integration\n\n1. Sign in to Pxsol and open **Integrations** or **Marketplace**.\n2. Find **Integraciones Generales (API Keys)** and select **Install**.\n3. Review the service terms, including the recurring **USD 50/month charge for the current company**.\n4. Accept the terms and select **Install**.\n5. After installation, Pxsol redirects you to **My API Keys**. Confirm that the **Create API Key** button is available.\n\nIf you manage more than one company, enable the module separately for each company that requires API access. The monthly charge applies to each enabled company.\n\n## 2. Create an API key\n\nFrom **My API Keys**, select **Create API Key** and configure:\n\n- **Name:** Use a descriptive name that identifies the integration and its purpose.\n- **Associated user:** Select an existing Pxsol user. The API key operates with that user's permissions, and actions performed with the key are attributed to that user.\n- **Expiration:** Set a defined validity period. A fixed expiration, such as 12 months, is recommended to enforce periodic rotation.\n- **Scope:**\n  - **Implicit:** Grants access to the resources of the current property.\n  - **Explicit:** Restricts access to selected companies and properties, which is recommended for multi-property environments.\n- **Environment:** Select **Production** for operational API access.\n- **Permissions:** Enable only the capabilities required by the integration, such as viewing hotel data, checking availability, creating reservations, or listing reservations.\n\nWhen the configuration is complete, select **Create API Key**.\n\n## 3. Copy and protect the token\n\nPxsol displays the generated access token **only once**.\n\n1. Copy the token immediately.\n2. Store it in a secure secret manager. Do not commit it to source control or expose it in client-side code.\n3. Confirm **Yes, I copied it** only after the token has been stored safely.\n4. Verify that the new key appears in **My API Keys** with an **Active** status and the expected expiration date.\n\nIf the token is lost or exposed, revoke the key and create a new one. A previously displayed token cannot be recovered.\n\n## 4. Authenticate API requests\n\nSend the token as a Bearer credential in every request:\n\n```http\nAuthorization: Bearer <YOUR_API_KEY>\nAccept: application/json\n```\n\nThe key's effective access is limited by its associated user, configured scope, and enabled permissions. Requests outside that access are rejected.\n\n## 5. Start integrating\n\nUse the endpoint reference in this documentation to build and test your integration. Begin with read-only operations, verify the company/property scope, and then enable write permissions only when required.\n\nFor the illustrated setup procedure, see [Managing API Keys for Integrations](https://ayuda.pxsol.com/integraciones/como_crear_apikeys_compressed).\n\n# Available capabilities\n\nDepending on the permissions granted to the key, integrations can:\n\n- View and create reservations.\n- Read and update availability, rates, inventory, and restrictions.\n- Retrieve hotel information, categories, rate plans, policies, and occupancy rules.\n- List and inspect invoices, receipts, and other accounting documents.\n- Access company reports and conversation endpoints.\n\n# Security recommendations\n\n- Apply least privilege: grant only the permissions and scope the integration needs.\n- Use a dedicated associated user whenever possible.\n- Set an expiration date and rotate keys periodically.\n- Store tokens only in server-side secret storage.\n- Revoke keys that are unused, compromised, or no longer required.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"26875477","team":578681,"collectionId":"179dc035-4f20-49c0-8589-3cba6bf9ea1e","publishedId":"2s93mAVL85","public":true,"publicUrl":"https://developers.pxsol.com","privateUrl":"https://go.postman.co/documentation/26875477-179dc035-4f20-49c0-8589-3cba6bf9ea1e","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"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":"FF6C37"}}]}},"version":"8.12.3","publishDate":"2024-08-12T15:44:55.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":null}},"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/5e262d7af54102b632fbb86dbb1e674808a89ccf14be983a29695f8b0c571c7e","favicon":"https://res.cloudinary.com/postman/image/upload/v1597344420/team/enxtzjrdo9gbgeiq6vro.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://developers.pxsol.com/view/metadata/2s93mAVL85"}