Puoi integrare il tuo gestionale alberghiero tramite API (Application Programming Interface).
Contatta la tua software house e fornisci la seguente documentazione.
Documentazione PayTourist API
Reservations
Tramite L’API “RESERVATIONS” il sistema permette l’inserimento, l’aggiornamento, l’eliminazione o il recupero massivo di prenotazioni generate da gestionali alberghieri di terze parti.
Per poter utilizzare il servizio si necessita di un token di accesso che può essere generato solo dagli utenti principali della struttura tramite apposite funzionalità dell’area privata e la software house deve essere censita con uno specifico codice nei nostri sistemi.
Le operazioni supportate sono “INSERT”, “UPDATE”, “DELETE” , “RETRIEVE”
Headers
Tutte le chiamate api (comprese quelle per il reperimento dei dati accessori) richiedono le seguenti opzioni nel proprio header.
Chiave |
Valore |
Authorization
|
Bearer TOKEN (Rilasciato dall’Utente)
|
Accept
|
application/json
|
Gestione Reservations
Il parser PayTourist distingue automaticamente le prenotazioni da inserire, modificare o eliminare dal medesimo endpoint.
Endpoint di accesso
Url |
Metodo |
https://nomecomune.paytourist.com/api/v1/reservations
|
POST
|
Struttura del contenuto
Il corpo della request dovrà contenere un solo field (dal nome data) con all’interno l’elenco delle “reservations” in formato JSON.
E’ possibile visionare un esempio completo della “REQUEST” nel file in basso.
REQUEST DI JSON
{
"structure_id": "[int]",
"reservations": [
{
"partner_id": "[string]",
"checkin": "[date]",
"checkout": "[date]",
"guests": [
{
"partner_id": "[string]",
"partner_room_id": "[int]",
"name": "[string]",
"surname": "[string]",
"email": "[string]",
"check_in_date": "[date]",
"check_out_date": "[date]",
"type_id": "[int]",
"document_type_id": "[int]",
"document_number": "[string]",
"document_released_by_country": "[int]",
"document_released_by_city": "[int]",
"sex": "[int]",
"nationality": "[int]",
"residence_country": "[int]",
"residence_city": "[int]",
"date_of_birth": "[date]",
"birth_country": "[int]",
"birth_city": "[int]",
"tax_refused": "[int]",
"reduction_id": "[int]",
},
{
"partner_id": "[string]",
"partner_room_id": "[int]",
"name": "[string]",
"surname": "[string]",
"check_in_date": "[date]",
"check_out_date": "[date]",
"sex": "[int]",
"nationality": "[int]",
"residence_country": "[int]",
"residence_city": "[int]",
"date_of_birth": "[date]",
"birth_country": "[int]",
"birth_city": "[int]",
"tax_refused": "[int]",
"reduction_id": "[int]",
}
]
}
]
}
Di seguito la descrizione dei campi e le rispettive caratteristiche:
Nodo “data”
Nome Campo |
Tipo |
Caratteristiche |
structure_id
|
intero
|
Obbligatorio - Id Paytourist della struttura
|
reservations
|
array[reservation]
|
Obbligatorio - Array di reservations
|
Nodo “reservation”: Da compilare per operazioni di inserimento e modifica
Nome Campo |
Tipo |
Caratteristiche |
partner_id
|
alfanumerico
|
Obbligatorio - Id reservation del gestionale
|
partner_room_id
|
alfanumerico
|
Obbligatorio - Id room del gestionale
|
check_in_date
|
format: yyyy-mm-dd
|
Obbligatorio
|
check_out_date
|
format: yyyy-mm-dd
|
Obbligatorio
|
guests
|
array[guests]
|
Obbligatorio
|
Nodo “reservation”: da compilare per operazioni di eliminazione
Nome Campo |
Tipo |
Caratteristiche |
partner_id
|
alfanumerico
|
Obbligatorio - Id reservation del gestionale
|
is_deleted
|
bool
|
Obbligatorio
|
Nodo “Guest”
Nome Campo |
Tipo |
Caratteristiche |
partner_id
|
Stringa
|
Obbligatorio Id guest del gestionale
|
name
|
Stringa
|
Obbligatorio solo nell’ospite principale
|
surname
|
Stringa
|
Obbligatorio solo nell’ospite principale
|
email
|
Formato aaa@bbb.ccc
|
Facoltativo
|
check_in_date
|
Formato: yyyy-mm-dd
|
Se non presente verrà utilizzato il check in della reservation
|
check_out_date
|
Formato: yyyy-mm-dd
|
Se non presente verrà processato il checkout della reservation
|
type_id
|
Intero
|
Obbligatorio solo per Ospite Principale - Vedi elenco “Guest Types”
|
document_type
|
Intero
|
Vedi elenco “Document Types”
|
document_number
|
Stringa
|
Facoltativo |
document_released_by_country
|
Intero
|
Vedi elenco “Nations”
|
document_released_by_city
|
Intero
|
Compilabile solo per gli utenti italiani. |
sex
|
ENUM (1,2)
|
Facoltativo 1=M, 2=F
|
nationality
|
Intero
|
Vedi elenco “Nations”
|
residence_country
|
Intero
|
Vedi elenco “Nations”
|
residence_city
|
Intero
|
Compilabile solo per gli utenti italiani. |
date_of_birth
|
Formato: yyyy-mm-dd
|
Facoltativo
|
birth_country
|
Intero
|
Vedi elenco “Nations”
|
birth_city
|
Intero
|
Vedi elenco “Cities”
|
tax_refused
|
Intero
|
Valore 1 se rifiuta, 0 o null altrimenti
|
reduction_id
|
Intero
|
Vedi elenco “Reductions”
|
partner_room_id
|
Stringa
|
Obbligatorio - id della stanza del partner
|
partner_room_name
|
Stringa
|
Nome della stanza (Facoltativo)
|
Informazioni aggiuntive nodo Guest
In caso di aggiornamento di una prenotazione il parser effettuerà la sincronizzazione dei guest per differenza, dunque nel caso si voglia eliminare un ospite basterà non inserirlo nella nuova chiamata di aggiornamento della "reservation".
Recupero Reservations
Il parser PayTourist recupera la lista delle prenotazioni generate da gestionali alberghieri di terze parti.
Endpoint di accesso
Url |
Metodo |
https://nomecomune.paytourist.com/api/v1/reservations |
GET
|
Parametri
Nome Campo |
Tipo |
Caratteristiche |
structure_id
|
Stringa
|
Obbligatorio ID struttura (paytourist)
|
partner_id
|
Stringa
|
Filtro per id reservation (Facoltativo)
|
perpage
|
Intero
|
Numero reservations per Pagina (default 10)
|
Chiamate REST delle informazioni accessorie
Tramite le seguenti chiamate è possibile ottenere le informazioni utente e le liste dati accessorie alla compilazione dei campi
Url |
Lista |
Metodo |
https://nomecomune.paytourist.com/api/v1/users/me |
Utente proprietario token
|
GET
|
https://nomecomune.paytourist.com/api/v1/structures |
Strutture associate al token
|
GET
|
https://nomecomune.paytourist.com/api/v1/nations
|
Nazioni
|
GET
|
https://nomecomune.paytourist.com/api/v1/cities
|
Città
|
GET
|
https://nomecomune.paytourist.com/api/v1/documents-types
|
Tipologie di documento
|
GET
|
https://nomecomune.paytourist.com/api/v1/guests-types
|
Tipologie di ospite
|
GET
|
https://nomecomune.paytourist.com/api/v1/reductions |
Elenco riduzioni
|
GET
|
Tariffazione delle tasse per periodo
Url : https://nomecomune.paytourist.com/api/vi1/tax-rules
Nome Campo |
Tipo |
Caratteristiche |
start_date
|
Formato: yyyy-mm-dd
|
Obbligatorio
|
end_date
|
Formato: yyyy-mm-dd
|
Obbligatorio
|
structure_id
|
Intero
|
Obbligatorio - Id Paytourist della struttura
|
Validatori
Tutte le richieste vengono validate dalle seguenti regole:
La data di check out della reservations e dei guests deve essere successiva a quella di check in.
Lista reservations
Url : https://nomecomune.paytourist.com/api/vi1/reservations
Metodo GET
Nome Campo |
Tipo |
Caratteristiche |
structure_id
|
Stringa
|
Obbligatorio ID struttura (paytourist)
|
partner_id
|
Stringa
|
Filtro per id reservation
|
perpage
|
Intero
|
Numero reservations per Pagina (default 10)
|
Area Test
Per l'area test bisogna sostituire il "nomecomune.paytourist.com" con "test.paytourist.com"
Per supporto in merito all'integrazione potete scrivere a sviluppo@paytourist.com
Commenti
0 commenti
Questo articolo è chiuso ai commenti.