Account settings

These endpoints exist so you can create and configure a whole account without going into the panel — useful if you run many accommodations or if you automate onboarding for your own customers.

General settings

curl -X PATCH https://api.kinapi.es/api/v1/settings \
  -H "ocp-apim-subscription-key: YOUR_API_KEY" \
  -H "content-type: application/json" \
  -d '{"ses":{"submitRequiresSignature":true}}'

curl -X PATCH https://api.kinapi.es/api/v1/settings \
  -H "ocp-apim-subscription-key: YOUR_API_KEY" \
  -H "content-type: application/json" \
  -d '{"notifications":{"guestInvitations":{"enabled":false,"reminder":true,"lastCall":true},"guestReplyTo":"bookings@example.com"}}'

Form branding (white-labelling)

Customise what your guests see with your colour, your logo and your trading name: their registration page and the header of their emails. It never changes the panel or the contracts.

# colour and logo at once
curl -X PATCH https://api.kinapi.es/api/v1/branding \
  -H "ocp-apim-subscription-key: YOUR_API_KEY" \
  -H "content-type: application/json" \
  -d "{\"primaryColor\":\"#0B6E4F\",\"logo\":\"$(base64 -i logo.png)\"}"

Outgoing webhook

Configure which URL we notify and about which events. The GET also returns the list of available events and the secret we sign each delivery with — the same one you need to verify the x-kinapi-signature-sha256 header (how to verify it). Event labels come back in Spanish by default; add ?locale=en (or send an Accept-Language header) to get them in English. The id of each event never changes.

curl -X PUT https://api.kinapi.es/api/v1/webhook \
  -H "ocp-apim-subscription-key: YOUR_API_KEY" \
  -H "content-type: application/json" \
  -d '{"url":"https://your-system.com/hooks/kinapi","events":["ses.confirmed","ses.error"]}'

Testing and debugging the webhook

The test sends a real delivery and returns the outcome of the attempt (HTTP code, duration and the body your server answered with), without waiting for an event to happen. The history keeps the attempts of the last 30 days.

curl -X POST https://api.kinapi.es/api/v1/webhook/test \
  -H "ocp-apim-subscription-key: YOUR_API_KEY"

Billing portal

Returns a single-use URL to the Stripe portal, where your account can see invoices and change the payment method. It expires: request a new one each time, do not store it.

Email notifications

Kinapi can write to the guest so they complete their registration, and tell you when a booking is fully registered. Both are off by default, deliberately: if your PMS already sends the link in its welcome message, turning them on means the guest gets the same email twice from the same property. You enable them under Settings → Notifications, or through the API with notifications.guestInvitations.

If you send the link yourself — from your PMS, with the url the API returns — switch the invitation off and keep the reminder and the last notice on. Kinapi only writes to guests who have not registered yet: whoever fills in with your link gets nothing from us, and whoever does not gets the reminder and the last notice.

Your texts in the guest emails

You can change the subject, the headline and the opening text of the invitation, the reminder and the last notice, in each language. Whatever you leave empty goes out with the Kinapi text. In the panel it is under Settings → Notifications → Email texts, with a preview and a test send; through the API, in guestEmails on PATCH /settings.

curl -X PATCH https://api.kinapi.es/api/v1/settings \
  -H "ocp-apim-subscription-key: YOUR_API_KEY" \
  -H "content-type: application/json" \
  -d '{"guestEmails":{"reminder":{"en":{"subject":"{nombre}, we look forward to seeing you at {alojamiento}","body":"We are still missing your details.\n\nIt takes two minutes and you arrive with everything done."},"es":null}}}'

When the invitation goes out. You choose the lead time, but neither extreme works. Too early fails: someone who gets the email three weeks out does not have every traveller’s document to hand, parks it and never returns — and the booking can still change or be cancelled. The day itself fails too: the guest is travelling, never opens it, and that night the report goes out incomplete. The default leaves room for the reminder and for you to react if nobody answers.

At most three emails per booking go out, and they stop as soon as every guest has registered. If two of them would fall on the same day, only one is sent.