The Hotelinking Api allows you to programmatically retrieve information from your guests.
\nAn API Key is required to be sent as part of every request, in the form of an X-Api-Key request header.
\nIf you do not have an API Key, you need to contact us to get one.
\nAn API Key tells our API server that the request it received came from you.
\nIf an API Key is missing, malformed, or invalid, you will receive a 403 Forbidden response code and the following JSON response:
\n{\n \"Message\": \"User is not authorized to access this resource with an explicit deny\"\n}\nAPI access rate limits are applied at a per-key basis in unit time. Access to the API using a key has some limit configured for each API key.
\nOnce you hit the rate limit, you will receive a response similar to the following JSON, with a status code of 429 Too Many Requests.
\n{\n \"Message\": \"Rate Limit exceeded\"\n}\nIn case that you need more rate limits, please contact us
\nIf you need we have available a mock server, to test this requests, here's the mock server to try it out:
\nYou can get the collection
\nYou can use the provided environment
\nThe URL for this server is: https://aac55c40-98c9-45dc-9505-9494d038283f.mock.pstmn.io
\nYou can use all the requests available here witht this mocked server, and tests differents response codes.
\nHere's an example:
\nRequest \"List Brand Users\":
\ncURL request:
\n{ \n\"curl --location 'https://aac55c40-98c9-45dc-9505-9494d038283f.mock.pstmn.io/brands/76/gdpr?lang=es' --data ''\"\n}\nThis will return a 200 OK with mock data.
\nIf you wish to try a different responde code (I.E. a 400), you can pass the header x-mock-response-code, in the headers, to mock this response.
\ncURL request:
\n{\n \"curl --location 'https://aac55c40-98c9-45dc-9505-9494d038283f.mock.pstmn.io/brands/76/gdpr?lang=es' --header 'x-mock-response-code: 400' --data ''\"\n}\nYou can view the full documentation of this mock server, here
\nFor any need of support you can contact us by send a e - mail or contacting your Key Account manager.
\nIn the event you receive a *503/ 504 * response from our servers, it implies that we have hit an unexpected spike in API access traffic and would usually be operational within the next 5 minutes.If the outage persists, or your receive any other form of * 5XX error *, kindly let us know.
\nemail: integrations@hotelinking.com
\nCreates a new contact in the CRM system after validating the quality of the email address.
\n","urlObject":{"path":["crm","users",":user_id","sites",":site_id","contacts"],"host":["https://api.hotelinking.com"],"query":[],"variable":[{"id":"c044bbeb-114e-4657-9af9-dcfdd53747f1","description":{"content":"(Required) CRM user identifier
\n","type":"text/plain"},"type":"any","value":"(Required) CRM site identifier
\n","type":"text/plain"},"type":"any","value":"Retrieves a list of available custom fields that can be used when creating CRM contacts for the specified user and site
\n","urlObject":{"path":["crm","users",":user_id","sites",":site_id","custom_fields"],"host":["https://api.hotelinking.com"],"query":[],"variable":[{"id":"7ae4c9ee-f542-4021-930c-ab25fd87eab9","description":{"content":"(Required) CRM user identifier
\n","type":"text/plain"},"type":"any","value":"(Required) CRM site identifier
\n","type":"text/plain"},"type":"any","value":"Retrieves contact information from the CRM system using the contact's email address.
\n","urlObject":{"path":["crm","users",":user_id","sites",":site_id","contacts",":email"],"host":["https://api.hotelinking.com"],"query":[],"variable":[{"id":"f21c1921-51be-43b4-b498-82dacd343a99","description":{"content":"(Required) CRM user identifier
\n","type":"text/plain"},"type":"any","value":"(Required) Contact email address
\n","type":"text/plain"},"type":"any","value":"(Required) CRM site identifier
\n","type":"text/plain"},"type":"any","value":"Updates contact information in the CRM system using the contact's email address. Only the fields provided in the request body will be updated (partial update).
\n","urlObject":{"path":["crm","users",":user_id","sites",":site_id","contacts",":email"],"host":["https://api.hotelinking.com"],"query":[],"variable":[{"id":"7bea51d4-e420-4480-94dd-7870bbfb768b","description":{"content":"(Required) CRM user identifier
\n","type":"text/plain"},"type":"any","value":"(Required) Contact email address to update
\n","type":"text/plain"},"type":"any","value":"(Required) CRM site identifier
\n","type":"text/plain"},"type":"any","value":"Returns the product info for the brand
\n","urlObject":{"path":["brands",":brand_id","products",":product_id"],"host":["https://api.hotelinking.com"],"query":[],"variable":[{"id":"5a46b0e5-efc3-4673-a004-e2aa2d615daf","description":{"content":"(Required)
\n","type":"text/plain"},"type":"any","value":"(Required)
\n","type":"text/plain"},"type":"any","value":"Returns the products for the brand
\n","urlObject":{"path":["brands",":brand_id","products"],"host":["https://api.hotelinking.com"],"query":[],"variable":[{"id":"bf5674c8-866c-4b9d-879f-f25d7d92b3e9","description":{"content":"(Required)
\n","type":"text/plain"},"type":"any","value":"Returns a reservation
\n","urlObject":{"path":["integrations","brands",":brand_id","reservations","pre-check"],"host":["https://api.hotelinking.com"],"query":[],"variable":[{"id":"db1750bb-e070-458d-94d1-b457ac2cdee7","description":{"content":"(Required) Brand identifier
\n","type":"text/plain"},"type":"any","value":"