Le credenziali API sono come un nome utente e una password che permettono a un altro sistema di collegarsi al tuo account Amenitiz e leggere i dati della tua struttura, come camere, tariffe, disponibilità, prenotazioni e fatture. Una credenziale si limita a leggere: nulla di ciò che colleghi in questo modo può modificare qualcosa in Amenitiz.

Le usi se vuoi collegare Amenitiz a uno strumento esterno, o se uno sviluppatore sta creando un'integrazione per la tua struttura. Non conosci l'API? Parti da Come capire l'API di Amenitiz.

Prima di iniziare

L'API di Amenitiz è in beta ed è ancora in fase di rilascio, quindi alcuni dettagli potrebbero cambiare.

Per creare credenziali API devi essere sul piano Advanced ed essere il titolare dell'account. I membri del team non possono creare né gestire credenziali.

Tieni a portata di mano la tua password Amenitiz: ti verrà chiesta per completare l'operazione.

Passo passo

Vai su Impostazioni.
Apri Credenziali API.
Clicca su Nuova credenziale.
Dalle un nome che riconoscerai in seguito, per esempio lo strumento che stai collegando, come "Esportazione contabile".
In Cosa può leggere?, seleziona solo ciò che lo strumento ti ha chiesto: devi selezionare almeno una voce. Potrai cambiarlo in seguito.
Se hai più di una struttura, seleziona quali copre la credenziale in Quali strutture?. Con una sola struttura non c'è nulla da scegliere.
Clicca su Crea credenziale.
Inserisci la tua password Amenitiz quando compare Verifica che sei tu, poi clicca di nuovo su Crea credenziale.
Copia il Client ID e il segreto, oppure clicca su Scarica come file per salvarli.
Clicca su Fatto.

📌 Nota

Non c'è niente da memorizzare. Se perdi il segreto, apri di nuovo la credenziale e Amenitiz te lo mostrerà dopo aver verificato la tua password.

Ora puoi consegnare il Client ID e il segreto al tuo sviluppatore, oppure incollarli nello strumento che stai collegando.

Scegliere cosa può leggere una credenziale

Una credenziale legge solo ciò che selezioni, quindi seleziona solo ciò che lo strumento ti ha chiesto. Le sei opzioni sono:

Tipologie di camere e camere: i dettagli della tua struttura, le tue tipologie di camere e le singole camere che le compongono.
Tariffe e offerte: piani tariffari, extra, promozioni e condizioni di vendita.
Calendario disponibilità: giorno per giorno, cosa è disponibile, il prezzo ed eventuali soggiorni minimi.
Prenotazioni e dettagli degli ospiti: prenotazioni, addebiti e pagamenti, compresi nome, e-mail, telefono e indirizzo di ogni ospite e tutto ciò che ha scritto nelle sue richieste.
Conti, fatture e pagamenti in uscita: i conti, le fatture e le note di credito che hai emesso, compresi i dati di fatturazione dei tuoi clienti, e il tuo conto per i pagamenti in uscita.
Impostazioni della struttura e team: orari di check-in, e-mail automatiche e nomi, e-mail e permessi del tuo team.

🚫 Attenzione

Le ultime tre opzioni riguardano dati personali e sensibili. I tuoi ospiti non hanno mai acconsentito a condividere i loro dati con lo strumento che stai collegando: stai decidendo tu al posto loro. Seleziona Prenotazioni e dettagli degli ospiti, Conti, fatture e pagamenti in uscita e Impostazioni della struttura e team solo quando lo strumento ne ha davvero bisogno.

Gestire le tue credenziali

Aprendo una credenziale puoi:

Copiare il Client ID.
Mostrare il segreto per rivederlo, e Nascondilo quando hai finito.
Sostituire il segreto con uno nuovo. Fallo se pensi che il tuo segreto sia stato condiviso o sia trapelato. Il Client ID resta invariato, cambia solo il segreto, e qualsiasi strumento che usa ancora il vecchio segreto perde l'accesso finché non incolli quello nuovo.
Revocare la credenziale per disattivarla in modo permanente. Amenitiz ti chiede di digitare il nome della credenziale per confermare, poi qualsiasi strumento che la usa perde l'accesso immediatamente.
Cambiare cosa può leggere la credenziale, selezionando o deselezionando le stesse sei opzioni, e cambiare quali strutture copre.

⚠️ Importante

Amenitiz ti chiede di confermare la password del tuo account prima di mostrare o sostituire un segreto. Il segreto dà accesso ai dati della tua struttura, quindi verifichiamo che sia davvero tu.

📌 Nota

La revoca dell'accesso ha effetto immediato e lo strumento viene disconnesso finché non si riconnette. L'aggiunta di accesso ha effetto solo alla prossima connessione.

Tenere al sicuro le tue credenziali

Tratta il segreto come una password:

Non condividerlo mai pubblicamente e non inviarlo via e-mail o chat non protette.
Dallo solo a strumenti e persone di cui ti fidi.
Se pensi che sia stato esposto, sostituiscilo subito.

Per gli sviluppatori

La documentazione tecnica completa è su developers.amenitiz.com.

Amenitiz non fornisce supporto tecnico per le implementazioni dell'API. È un'integrazione avanzata offerta in modalità self-service.

Sono sul piano Advanced ma non vedo Credenziali API

L'API è ancora in fase di rilascio, quindi potrebbe non essere ancora arrivata sul tuo account. Verifica di aver effettuato l'accesso come titolare dell'account, poi contatta il nostro team di supporto.

Un membro del team può creare credenziali API?

No. Solo il titolare dell'account può creare una credenziale, mostrare o sostituire un segreto, o revocare una credenziale.

Ho perso il segreto. Cosa faccio?

Apri la credenziale e clicca su Mostra, poi conferma la password del tuo account. Non hai perso nulla: devi sostituire il segreto solo se pensi che qualcun altro l'abbia visto.

Posso cambiare cosa può leggere una credenziale dopo averla creata?

Sì. Apri la credenziale e seleziona o deseleziona le opzioni. La revoca dell'accesso ha effetto immediato; l'aggiunta di accesso raggiunge lo strumento alla sua prossima connessione.

Devo creare una credenziale per ogni strumento?

Sì. Una credenziale separata per ogni strumento ti permette di sostituirne o revocarne una senza interrompere le altre, di dare a ogni strumento solo l'accesso che gli serve e di vedere a colpo d'occhio a quale strumento appartiene ciascuna credenziale.

Ho revocato una credenziale per errore. Posso riattivarla?

No. La revoca è definitiva. Crea una nuova credenziale e consegna il nuovo Client ID e il nuovo segreto allo strumento o allo sviluppatore.

Come creare e gestire le tue credenziali API