Skip to content

Authenticate Contact

Andrew Jones edited this page Feb 12, 2021 · 2 revisions

Request Url: /apis/contact/authenticate

  • Method POST

  • Content-Type application/x-www-form-urlencoded

  • Payload

  1. Specify "Email" in request payload to provide email address
  2. Specify "Password" in request payload to provide password

How to implement

This API endpoint is used to validate a guest using your own checkout pages, the guest can provide their email and password and the API will validate that they have an account and the details match. You can then process the booking against an existing contactID to keep everything in sync.

Success response:

{
  Success: true,
  Contact: contact_object,
  Message: ""
}

Contact object

{
"Id": 68,
"CompanyId": 1,
"FullName": "Ipro Software",
"Country": "United Kingdom",
"Title": "",
"FirstName": "Ipro",
"LastName": "Software",
"Language": null,
"Email": "info@ipro-software.com",
"EmailAlt": "",
"EmailAlt1": "",
"Telephone": "",
"TelephoneAlt": "",
"Mobile": "",
"Postcode": ".123",
"Address": "17 Bolts Croft",
"StreetName": "",
"TownCity": ".test",
"CountyArea": "Wiltshire",
"CountryCode": "GB",
"CompanyName": "iPro Holidays",
}

Error response:

{
  Success: false,
  Contact: null,
  Message: "Error description"
}
Clone this wiki locally