Halaman ini diterjemahkan oleh Cloud Translation API.

Mulai menggunakan Apigee API

Halaman ini berlaku untuk Apigee dan Apigee hybrid.

Lihat dokumentasi Apigee Edge.

Apigee API dapat digunakan untuk mengembangkan dan mengelola API secara terprogram dengan serangkaian operasi RESTful.

Anda dapat menggunakan Apigee API untuk mengintegrasikan pengelolaan proxy API ke dalam siklus proses pengembangan software (SDLC) organisasi Anda. Penggunaan umum Apigee API adalah untuk menulis skrip atau kode yang men-deploy proxy API atau memigrasikan proxy API dari satu lingkungan ke lingkungan lain, sebagai bagian dari proses otomatis yang lebih besar yang juga men-deploy atau memigrasikan aplikasi lain.

Untuk informasi selengkapnya, lihat Apigee API.

Mengaktifkan Apigee API

Pastikan Anda telah mengaktifkan Apigee API. Cara termudah untuk mengaktifkan API untuk project Anda adalah menggunakan konsol Google Cloud. Untuk mengetahui detail selengkapnya, lihat Langkah 3: Mengaktifkan API.

Mendapatkan token akses OAuth 2.0

Apigee API mendukung OAuth 2.0 untuk autentikasi pengguna. Dengan OAuth 2.0, Anda menukar kredensial Google Cloud dengan token akses yang kemudian dapat Anda gunakan untuk melakukan panggilan aman ke Apigee API. Setelah mendapatkan token, Anda tidak perlu bertukar kredensial lagi hingga masa berlaku token berakhir.

Mendapatkan token menggunakan kredensial Google Cloud

Untuk mendapatkan token menggunakan kredensial Google Cloud Anda:

Izinkan gcloud untuk mengakses Cloud Platform dengan kredensial pengguna Google Anda:
```
gcloud auth login
```

Dapatkan token untuk akun yang saat ini aktif:

export TOKEN=$(gcloud auth print-access-token)

Saat Anda memanggil Apigee API, teruskan token akses di header Authorization. Contoh:
```
curl "https://apigee.googleapis.com/v1/organizations" -H "Authorization: Bearer $TOKEN"
```

Mendapatkan token menggunakan kunci akun layanan Google Cloud

Untuk mendapatkan token menggunakan kunci akun layanan untuk otorisasi:

Buat kunci untuk akun layanan Anda menggunakan konsol GCP, seperti yang dijelaskan dalam Membuat dan mengelola kunci akun layanan.
File JSON yang berisi kredensial akun layanan Anda akan didownload ke komputer Anda.
Tetapkan variabel lingkungan GOOGLE_APPLICATION_CREDENTIALS ke jalur tempat kunci akun layanan berada:
```
export GOOGLE_APPLICATION_CREDENTIALS=your_sa_credentials_file.json
```

Saat Anda memanggil Apigee API, gunakan Google Cloud CLI untuk menambahkan token akses ke header Otorisasi. Contoh:

curl "https://apigee.googleapis.com/v1/organizations" -H "Authorization: Bearer $(gcloud auth application-default print-access-token)"

Menetapkan variabel lingkungan untuk permintaan Apigee API

Contoh Apigee API dan gcloud CLI yang diberikan di seluruh dokumentasi menggunakan satu atau beberapa variabel lingkungan yang ditentukan dalam tabel berikut.

Dengan menetapkan variabel lingkungan di awal ke nilai yang bermakna di lingkungan Anda, Anda dapat menyalin dan menempelkan contoh permintaan untuk menjalankannya di lingkungan Anda sendiri dengan sedikit atau tanpa modifikasi.

Variabel lingkungan	Deskripsi
`$API`	Nama proxy API Anda.
`$APIPRODUCT`	Nama produk API.
`$APP`	ID aplikasi.
`$DEVELOPER_EMAIL`	Alamat email developer.
`$ENV`	Nama lingkungan Anda, seperti `test` atau `prod`.
`$ID`	ID resource.
`$KEY`	Kunci konsumen.
`$NAME`	Nama resource Anda.
`$ORG`	Organisasi Apigee Anda.
`$REV`	Nomor revisi proxy API Anda.
`$SHAREDFLOW`	Nama alur bersama Anda.
`$TYPE`	Jenis resource.

Menggunakan curl

Contoh dalam bagian ini menggunakan curl untuk menunjukkan cara mengembangkan aplikasi menggunakan Apigee API. curl adalah alat command line open source untuk mentransfer data dengan sintaksis URL, yang mendukung protokol umum seperti HTTP dan HTTPS.

Tabel berikut meringkas opsi command line curl yang digunakan dalam contoh.

Opsi	Deskripsi
`-d '{}' --data @filename --data-binary @filename`	Menentukan isi permintaan, yang dapat Anda teruskan secara langsung atau dengan menentukan nama file.
`-F file=@filename --form file=@filename`	Menentukan data berbasis formulir yang dapat Anda teruskan dengan menentukan nama file.
`-H --header`	Menentukan header permintaan. Anda harus meneruskan informasi berikut di header permintaan: Header `Authorization`: Token OAuth 2.0 untuk autentikasi pengguna, seperti yang dijelaskan dalam Mendapatkan token akses OAuth 2.0. Header `Content-Type`: Jenis konten isi permintaan yang dikirim saat membuat atau memperbarui resource (POST, PATCH, PUT) menggunakan API.
`-X`	Menentukan jenis permintaan (GET, POST, dan sebagainya).

Contoh:

curl "https://apigee.googleapis.com/v1/organizations/$ORG/apis" \
   -X GET \
   -H "Authorization: Bearer $TOKEN"

Dengan $TOKEN ditetapkan ke token akses OAuth 2.0 Anda, seperti yang dijelaskan dalam Mendapatkan token akses OAuth 2.0.