Partner API: gestiona claus i webhooks
Amb la Partner API connectes les teves pròpies pàgines de reserves, aplicacions i integracions amb STRYK. Crees claus amb exactament els drets necessaris i configures webhooks.
Contents
Abans de començar
- Necessites el dret Gestionar channels. Només així veus la fila API a la pàgina Canals.
- Aclareix quines àrees ha de llegir o escriure la integració. Una clau només rep aquests drets.
- Una integració crida la Partner API des del seu servidor. Mai posis la clau en codi del navegador ni en una aplicació. Els endpoints, paràmetres i exemples els trobes a la documentació per a desenvolupadors. Allà l'apartat Autenticació i àmbits explica què permet cada dret.
- Els webhooks necessiten un destinatari amb una adreça que comenci per https://.
Obre l'API
In STRYKCanals
- Tria sota Connexions pròpies la fila API amb la indicació «Claus d'API i webhooks». S'obre el diàleg API.
- Tria la pestanya Claus d'API o Webhooks. Amb Documentació per a desenvolupadors a la capçalera del diàleg obres el portal de desenvolupadors.
- Pestanyes Claus d'API i Webhooks
- Claus amb drets
- Accions de la clau
Crear clau d'API
In STRYKCanalsAPIClaus d'API
- Tria Crear clau d'API. S'obre el diàleg Crear clau d'API.
- Escriu el Nom, per exemple «Pàgina de reserves».
- Tria a Drets un patró: Només lectura (llegir totes les àrees), Lectura i escriptura (escriure allà on sigui possible) o Personalitzat. Amb Personalitzat tries per cada àrea Sense accés, Lectura o Escriptura. Les àrees són Hotel i habitacions, Disponibilitat, Preus i tarifes, Reserves, Hostes, Pagaments i Factures. Escriptura inclou Lectura. Les factures són comprovants fiscals de l'hotel i només es poden llegir per API.
- Opcional: obre Avançat. Tria la Caducitat: Sense caducitat, 30 dies, 90 dies, 1 any o Data (a partir de demà, com a màxim en tres anys). Escriu sota Restricció d'IP una adreça o una xarxa CIDR per línia, com a màxim 20. Buit permet totes les adreces. A Nota guardes una indicació interna.
- Tria Crea. STRYK mostra Clau d'API creada amb la clau i l'avís Només visible ara.
- Copia la clau i desa-la, per exemple, al gestor de contrasenyes. Tria Fet.
Gestiona les claus
In STRYKCanalsAPIClaus d'API
La llista mostra per cada clau el Nom, l'inici de la clau, els Drets, Creada, Últim ús, Caducitat i l'estat: Actiu, Caduca aviat, Revocada o Caducada. Tria una clau per veure Drets, Caducitat, Adreces IP permeses, Límit de freqüència (peticions per minut), Ús, Últimes soŀlicituds i l'Historial.
- Obre el menú Opcions de la fila.
- Tria Neu erzeugen si la integració ha de rebre una clau nova amb els mateixos drets. Sota Clau actual tria La clau antiga encara és vàlida 24 h, perquè puguis canviar la integració, o Revocar immediatament. Confirma amb Regenerar. STRYK mostra la clau nova una vegada.
- Tria Revoca i confirma Revocar la clau d'API? per bloquejar una clau de seguida. STRYK rebutjarà aleshores les peticions amb aquesta clau.
Configura els webhooks
In STRYKCanalsAPIWebhooks
Un webhook envia els esdeveniments escollits, signats, per HTTPS als teus sistemes.
- Tria Crea un webhook. S'obre el diàleg Nou webhook.
- Escriu la URL del destinatari, per exemple https://crm.nordlicht.invalid/hooks/stryk. L'adreça ha de començar amb https://.
- Opcional: escriu una Descripció, per exemple «Reserves al nostre CRM».
- Tria a Esdeveniments almenys un: Reserva creada, Reserva actualitzada, Reserva canceŀlada, Hoste modificat, Disponibilitat canviada, Preu modificat, Pagament modificat o Estat de l'habitació modificat. Amb Selecciona tot i Desselecciona tot tries tots o cap.
- Tria Crea un webhook. STRYK mostra El teu secret de signatura una sola vegada.
- Desa el secret al teu destinatari. Com el destinatari comprova la signatura ho descriu la documentació per a desenvolupadors a Webhooks i comprovació de la signatura.
- Tria el webhook i després Envia un esdeveniment de prova. STRYK indica «L'esdeveniment de prova s'està lliurant.»
Gestiona els webhooks
Ort: Canals > API > Webhooks, tria el webhook
- Amb l'interruptor Lliurament actiu pauses o actives el webhook. Els webhooks pausats no reben esdeveniments. Després d'activar-lo, el lliurament comença amb els esdeveniments nous.
- Últims 7 dies, Últim èxit i Últim error mostren l'estat. Sota Enviaments veus cada enviament amb Estat HTTP i Intents. Amb Torna a enviar repeteixes un enviament.
- Renova el secret crea un secret nou. L'anterior segueix sent vàlid durant 24 hores perquè puguis canviar el destinatari.
- Amb Edita canvies l'adreça i els esdeveniments; amb Suprimeix i la confirmació Eliminar el webhook? l'elimines. El registre de lliuraments es conserva 30 dies.
Així comproves el resultat
- A la clau apareix Últim ús amb la data, en quant la integració la utilitza. Soŀlicituds 24 h compta les peticions.
- Al webhook, Últims 7 dies mostra «{Zahl} lliurats, {Zahl} fallits», i l'esdeveniment de prova apareix a Enviaments.
Si alguna cosa no funciona
| Què veus | Causa | Com ho resols |
|---|---|---|
| «Tria almenys un dret.» | Cap àrea té un dret. | Tria un patró o dona almenys una àrea Lectura o Escriptura. |
| «Introdueix un nom.» | Falta el Nom. | Escriu un nom. |
| «Revisa:» amb una adreça | Una adreça de la Restricció d'IP no és vàlida. | Corregeix l'adreça o la xarxa CIDR. Són permeses com a màxim 20 entrades. |
| «Tria una data a partir de demà, com a màxim de tres anys.» | La data de caducitat és fora del període. | Tria una data a partir de demà que sigui com a màxim a tres anys vista. |
| «L'adreça ha de començar per https://.» | La URL del destinatari no és una adreça HTTPS. | Escriu una adreça amb https://. |
| «Tria almenys un esdeveniment.» | El webhook no té cap esdeveniment. | Tria almenys un a Esdeveniments. |
| Pausat per errors repetits | El destinatari no respon amb un estat 2xx. | Comprova que el destinatari sigui accessible i tria Torna a activar. |
| «Activa el webhook per enviar un esdeveniment de prova.» | El webhook està pausat. | Activa Lliurament actiu i envia l'esdeveniment de prova. |
| «La selecció no s'ha pogut carregar. Tanca-la i torna-la a obrir.» | La llista de drets i esdeveniments no s'ha carregat. | Tanca el diàleg i torna'l a obrir. |