Operasi Admin API dipetakan langsung ke kata kerja HTTP REST, yang berarti Anda menggunakan metode HTTP standar untuk mengambil dan memanipulasi resource.
Format spesifik untuk URI Admin API adalah:
https://appengine.googleapis.com/v1/resourcePath?parameters
Misalnya, untuk mencantumkan semua detail tentang versi my-v1 di layanan my-
frontend aplikasi dalam project my-app, Anda dapat mengirim permintaan HTTP dengan parameter ?view=FULL.
GET https://appengine.googleapis.com/v1/apps/my-app/services/my-frontend/versions/my-v1?view=FULL
Lihat dokumen Referensi App Engine Admin API untuk mengetahui kumpulan lengkap URI yang digunakan bagi setiap operasi yang didukung dalam API.
Pelajari dasar-dasarnya
Baru menggunakan REST API? Berikut ini beberapa referensi untuk membantu Anda memulai.
Dasar-dasar REST
Ada dua cara untuk memanggil API:
- Mengirim permintaan HTTP dan mengurai respons.
- Menggunakan library klien
Jika memutuskan tidak menggunakan library klien, Anda harus memahami dasar-dasar REST.
REST adalah gaya arsitektur software yang memberikan pendekatan yang praktis dan konsisten untuk meminta dan memodifikasi data.
Istilah REST adalah singkatan dari "Representational State Transfer". Dalam konteks Google API, hal ini mengacu pada penggunaan kata kerja HTTP untuk mengambil dan memodifikasi representasi data yang disimpan oleh Google.
Dalam sistem RESTful, resource disimpan di penyimpanan data; klien mengirim permintaan agar server melakukan tindakan tertentu (seperti membuat, mengambil, memperbarui, atau menghapus resource), dan server melakukan tindakan dan mengirim respons, sering kali dalam bentuk representasi resource yang ditentukan.
Di RESTful API Google, klien menentukan tindakan menggunakan kata kerja HTTP seperti POST, GET, PUT, atau DELETE. Kode ini menetapkan resource berdasarkan URI unik global untuk form berikut:
https://www.googleapis.com/apiName/apiVersion/resourcePath?parameters
Karena semua resource API memiliki URI unik yang dapat diakses HTTP, REST memungkinkan caching data dan dioptimalkan untuk berfungsi dengan infrastruktur terdistribusi web.
Anda dapat memperoleh manfaat dari definisi metode dalam dokumentasi standar HTTP 1.1; dokumentasi tersebut menyertakan spesifikasi untuk GET, POST, PUT, dan DELETE.
Dasar-dasar JSON
Admin API menampilkan data dalam format JSON.
JSON (JavaScript Object Notation) adalah format data umum independen bahasa yang memberikan representasi teks sederhana untuk struktur data arbitrer. Untuk informasi selengkapnya, lihat json.org.