{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"cf324324-b69f-4881-8a7c-68b7d2667c25","name":"West Wales Holiday Cottages - Partner APIs","description":"Welcome to the **West Wales Holiday Cottages Partner API**. This API allows our partners to retrieve **property listings, availability, pricing, and reviews**, while ensuring data integrity and performance. Designed with flexibility in mind, the API supports **HATEOAS (Hypermedia as the Engine of Application State)** principles, enabling seamless navigation through available resources.\n\nThis API is intended for **approved partners** who wish to integrate our property data into their platforms. It provides **real-time updates** on property availability, pricing adjustments, and user-generated content such as reviews.\n\n## **General API Rules & Best Practices**\n\n##### **1\\. Authentication & Security**\n\n- Each partner is issued an **API token**, which must be included in the `Authorization` header as a **Bearer token**.\n    \n- Tokens are **private credentials**—do not expose them in public repositories or client-side applications.\n    \n\n##### **2\\. HATEOAS Compliance**\n\n- Every response contains **links** to related resources, ensuring easy navigation.\n    \n- Clients should **always use these links** instead of constructing URLs manually.\n    \n\n##### **3\\. Data Integrity & Filtering**\n\n- Only **active properties** are returned in any API response.\n    \n- Responses are **paginated** to improve performance.\n    \n- The API supports **filtering** and **query parameters** where applicable.\n    \n\n##### **4\\. Rate Limiting & Performance**\n\n- The API enforces **rate limits** to ensure fair usage (`1000 requests per minute`).\n    \n- Large data sets (e.g., property listings) are **paginated**.\n    \n- Our \"changes\" endpoint respects the `X-Modified-Since` header, which allows efficient retrieval of only changed data.\n    \n\n##### **5\\. Handling Property & Availability Updates**\n\n- Use the **Changes API (****`/api/partners/properties/changes`****)** to fetch only properties that have been modified since a given date. Passing in your \"X-Modified-Since\" header with the last date and time that you crawled this end point.\n    \n- Availability, pricing, and reviews are fetched **separately** for performance reasons.\n    \n\n##### **6\\. Error Handling**\n\n- **HTTP Status Codes**:\n    \n    - `200 OK` – Successful response\n        \n    - `400 Bad Request` – Invalid input\n        \n    - `401 Unauthorized` – Missing or invalid token\n        \n    - `403 Forbidden` – Insufficient permissions\n        \n    - `404 Not Found` – Resource unavailable\n        \n    - `429 Too Many Requests` – Rate limit exceeded\n        \n\n---\n\n## Header Responses\n\nHeaders from our API results will include the following information which developers may find useful.\n\n- `X-RateLimit-Limit` - The total number of requests per minute this end point allows.\n    \n- `X-RateLimit-Remaining` - The remaining number of requests your IP is limited to.\n    \n\n---\n\n## **How to Get Started**\n\n1. **Obtain API Credentials** – Contact our team for access.\n    \n2. **Authenticate** – Include your API token in the `Authorization` header.\n    \n3. **Explore Endpoints** – Retrieve properties, availability, pricing, and reviews.\n    \n4. **Use HATEOAS Links** – Follow the provided links for seamless navigation.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"23538817","team":4087468,"collectionId":"cf324324-b69f-4881-8a7c-68b7d2667c25","publishedId":"2sAYkLmbvz","public":true,"publicUrl":"https://partners.westwalesholidaycottages.co.uk","privateUrl":"https://go.postman.co/documentation/23538817-cf324324-b69f-4881-8a7c-68b7d2667c25","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"38a169"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":"West Wales Holiday Cottages - Partner API"}],"appearance":{"default":"light","themes":[{"name":"dark","logo":"https://content.pstmn.io/6a1710e4-9aef-461d-a9a2-732b1bec0dd2/c3Zndmlld2VyLXBuZy1vdXRwdXQucG5n","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"38a169"}},{"name":"light","logo":"https://content.pstmn.io/e27014f4-c834-453d-b95c-2e57bd7e9bd8/c3Zndmlld2VyLXBuZy1vdXRwdXQucG5n","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"38a169"}}]}},"version":"8.10.1","publishDate":"2025-05-12T16:18:13.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"West Wales Holiday Cottages - Partner API","description":""},"logos":{"logoLight":"https://content.pstmn.io/e27014f4-c834-453d-b95c-2e57bd7e9bd8/c3Zndmlld2VyLXBuZy1vdXRwdXQucG5n","logoDark":"https://content.pstmn.io/6a1710e4-9aef-461d-a9a2-732b1bec0dd2/c3Zndmlld2VyLXBuZy1vdXRwdXQucG5n"}},"statusCode":200},"environments":[{"name":"Live","id":"51ec06ed-73bf-4417-89ce-7a23bbf917d9","owner":"23538817","values":[{"key":"domain","value":"https://hub.westwalesholidaycottages.co.uk","enabled":true,"type":"default"},{"key":"user_email","value":"nik@westwalesholidaycottages.co.uk","enabled":true,"type":"secret"},{"key":"user_password","value":"Vmktjx8ucGbnins","enabled":true,"type":"secret"},{"key":"token","value":"1|U4txARbC32FcbDBDN5vfzP9CJuFEEvxTDl0jsBsC6b7bc0f8","enabled":true,"type":"secret"}],"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/b906acd0ee69e4e84e6a30ad92e32de3a8ca7f56a9667f1abf766f3e5be27227","favicon":"https://westwalesholidaycottages.co.uk/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"},{"label":"Live","value":"23538817-51ec06ed-73bf-4417-89ce-7a23bbf917d9"}],"canonicalUrl":"https://partners.westwalesholidaycottages.co.uk/view/metadata/2sAYkLmbvz"}