Anda harus menyiapkan server pemesanan agar Pusat Tindakan dapat melakukan callback untuk membuat dan memperbarui pemesanan atas nama Anda.
- Penerapan Standar. Hal ini memungkinkan Pusat Action membuat janji temu, pemesanan, dan reservasi dengan Anda atas nama pengguna.
Lihat dokumentasi Portal Partner untuk mempelajari cara mengonfigurasi koneksi ke server pemesanan sandbox dan produksi Anda.
Menerapkan antarmuka REST API
Menerapkan antarmuka API berdasarkan REST. Hal ini memungkinkan Google mengirim permintaan server pemesanan melalui HTTP.
Untuk memulai, siapkan server pemesanan pengembangan atau sandbox yang dapat dihubungkan ke lingkungan sandbox Pusat Action. Hanya pindahkan ke lingkungan produksi setelah server sandbox sepenuhnya diuji.
Metode
Untuk setiap jenis server pemesanan, diperlukan kumpulan metode API yang berbeda. Anda juga dapat mendownload definisi layanan dalam format proto untuk memulai implementasi API. Tabel berikut menunjukkan metode untuk setiap penerapan dan menyertakan link ke format proto layanan.
Penerapan standar |
---|
Definisi layanan standar Mendownload file definisi layanan proto. |
Metode | Permintaan HTTP |
---|---|
HealthCheck | GET /v3/HealthCheck/ |
BatchAvailabilityLookup | POST /v3/BatchAvailabilityLookup/ |
CreateBooking | POST /v3/CreateBooking/ |
UpdateBooking | POST /v3/UpdateBooking/ |
GetBookingStatus | POST /v3/GetBookingStatus/ |
ListBookings | POST /v3/ListBookings/ |
Resource API
Reservasi
Jenis resource berikut digunakan dalam penerapan standar:
Alur: membuat pemesanan
Bagian ini membahas cara membuat pemesanan untuk penerapan standar.
![Gambar 1: Alur kerja untuk membuat pemesanan dari slot](https://developers-dot-devsite-v2-prod.appspot.com/static/actions-center/images/rest_api_v3_booking_flow_1.png?authuser=7&hl=id)
Saat pengguna membuat pemesanan, Google mengirimkan nama depan, nama belakang, nomor telepon, dan email pengguna. Dari sudut pandang Anda, pemesanan ini harus diperlakukan sebagai checkout tanpa login, karena Pusat Tindakan tidak dapat mencari akun pengguna di sistem Anda. Pastikan pemesanan akhir terlihat sama dengan pemesanan di penjual Anda yang berasal dari sistem pemesanan Anda.
Keamanan dan Autentikasi
Semua komunikasi ke server pemesanan Anda terjadi melalui HTTPS, sehingga sangat penting bagi server Anda untuk memiliki sertifikat TLS valid yang cocok dengan nama DNS-nya. Untuk membantu menyiapkan server Anda, sebaiknya gunakan alat verifikasi SSL/TLS yang tersedia secara publik, seperti SSL Server Test Qualys.
Semua permintaan yang akan dibuat Google ke server pemesanan Anda akan diautentikasi menggunakan autentikasi dasar HTTP. Kredensial autentikasi dasar (nama pengguna dan sandi) untuk server pemesanan Anda dapat dimasukkan di halaman Konfigurasi Server Pemesanan dalam Portal Partner. {i>Password<i} harus dirotasi setiap enam bulan.
Contoh Penerapan Skeleton
Untuk memulai, lihat contoh kerangka berikut dari server pemesanan yang ditulis untuk framework Node.js dan Java:
- Kerangka Node.js js-maps-booking-rest-server-v3-skeleton
- Skeleton Java java-maps-booking-rest-server-v3-skeleton
Server tersebut telah menghapus metode REST.
Persyaratan
Error HTTP dan error logika bisnis
Saat backend menangani permintaan HTTP, dua jenis error mungkin terjadi.
- Error yang terkait dengan infrastruktur atau data yang salah
- Tampilkan error ini ke klien dengan kode error HTTP standar. Lihat daftar kode status HTTP lengkap.
- Error yang terkait dengan logika bisnis
- Tampilkan kode status HTTP yang ditetapkan ke
200
OK, dan tentukan kegagalan logika bisnis dalam isi respons. Jenis error logika bisnis yang dapat Anda temui akan berbeda untuk berbagai jenis implementasi server.
- Tampilkan kode status HTTP yang ditetapkan ke
Untuk penerapan Standar, kemungkinan error logika bisnis tercantum dalam Kegagalan Pemesanan dan error tersebut ditampilkan dalam respons HTTP. Error logika bisnis mungkin terjadi saat resource dibuat atau diperbarui. Misalnya, saat Anda menangani metode CreateBooking
atau UpdatingBooking
. Contohnya mencakup, tetapi tidak terbatas pada, berikut ini:
SLOT_UNAVAILABLE
digunakan jika slot yang diminta tidak lagi tersedia.PAYMENT_ERROR_CARD_TYPE_REJECTED
digunakan jika jenis kartu kredit yang diberikan tidak diterima.
Idempotensi
Komunikasi melalui jaringan tidak selalu dapat diandalkan dan Google dapat mencoba lagi permintaan HTTP jika tidak ada respons yang diterima. Oleh karena itu, semua metode yang mengubah status harus idempoten:
CreateBooking
UpdateBooking
Untuk setiap pesan permintaan kecuali UpdateBooking
, token idempotensi disertakan untuk mengidentifikasi permintaan secara unik. Hal ini memungkinkan Anda membedakan antara panggilan REST yang dicoba lagi, dengan intent untuk membuat satu permintaan, dan dua permintaan terpisah.
UpdateBooking
masing-masing diidentifikasi secara unik oleh ID entri pemesanannya, sehingga tidak ada token idempotensi yang disertakan dalam permintaannya.
Berikut adalah beberapa contoh bagaimana server pemesanan menangani idempotency:
Respons HTTP
CreateBooking
yang berhasil mencakup pemesanan yang dibuat. Dalam beberapa kasus, pembayaran diproses sebagai bagian dari alur pemesanan. JikaCreateBookingRequest
yang sama persis diterima untuk kedua kalinya (denganidempotency_token
yang sama),CreateBookingResponse
yang sama harus ditampilkan. Tidak ada pemesanan kedua yang dibuat, dan pengguna ditagih hanya sekali, jika ada.Perhatikan bahwa jika percobaan
CreateBooking
gagal dan permintaan yang sama dikirim ulang, dalam kasus ini backend Anda harus mencoba lagi.
Persyaratan idempotency berlaku untuk semua metode yang mengubah status.