Contoh kode API

Halaman ini berisi contoh kode untuk Google Spectrum Access System (SAS) Portal API.

Sebelum memulai

Untuk contoh berikut, pastikan Anda menyelesaikan prasyarat berikut:

Mencantumkan pelanggan saat ini

  1. Menampilkan semua pelanggan yang dapat diakses oleh pemanggil:

    curl -X GET -H "X-Goog-User-Project: ${CLIENT_PROJECT}" \
     -H "Content-Type: application/json" \
     -H "Authorization: Bearer ${TOKEN}" \"https://sasportal.googleapis.com/v1alpha1/customers"
    
  2. Simpan nama pelanggan yang ditampilkan sebagai variabel:

    CUSTOMER_NAME=customers/...
    

Membuat konfigurasi perangkat baru

  1. Tetapkan ${FCCID} dan ${SN} perangkat yang ingin Anda buat:

    FCCID=f1
    SN=sn1
    
  2. Buat konfigurasi perangkat:

    curl -X POST -H "X-Goog-User-Project: ${CLIENT_PROJECT}" \
     -H "Content-Type: application/json" \
     -H "Authorization: Bearer ${TOKEN}" \ "https://sasportal.googleapis.com/v1alpha1/${CUSTOMER_NAME}/devices" \
     -d "{ \"fcc_id\": \"$FCCID\", \"serial_number\": \"$SN\", \"preloaded_config\": { \"call_sign\": \"cs1\", \"category\": \"DEVICE_CATEGORY_A\"}}"
    

    Perintah ini menampilkan konfigurasi perangkat yang baru dibuat.

  3. Simpan nama perangkat sebagai variabel:

    DEVICE_NAME=customers/.../devices/...
    

Mencantumkan perangkat saat ini

curl -X GET -H "X-Goog-User-Project: ${CLIENT_PROJECT}" \
 -H "Content-Type: application/json" \
 -H "Authorization: Bearer $TOKEN" \ "https://sasportal.googleapis.com/v1alpha1/${CUSTOMER_NAME}/devices"

Mengambil perangkat berdasarkan nama

curl -X GET -H "X-Goog-User-Project: ${CLIENT_PROJECT}" \
 -H "Content-Type: application/json" \
 -H "Authorization: Bearer $TOKEN" \
 "https://sasportal.googleapis.com/v1alpha1/${DEVICE_NAME}"

Memperbarui perangkat yang ada

curl -X PATCH -H "X-Goog-User-Project: ${CLIENT_PROJECT}" \
 -H "Content-Type: application/json" \
 -H "Authorization: Bearer $TOKEN" \
 "https://sasportal.googleapis.com/v1alpha1/${DEVICE_NAME}" \

Memvalidasi identitas dan sertifikasi Certified Professional Installer (CPI) Anda

  1. Buat string rahasia:

    curl -X POST -H "X-Goog-User-Project: ${CLIENT_PROJECT}" \
     -H "Content-Type: application/json" \
     -H "Authorization: Bearer $TOKEN" \ "https://sasportal.googleapis.com/v1alpha1/installer:generateSecret" \
     -d "{}"
    

    Outputnya mirip dengan hal berikut ini:

     {
      "secret": "<generated secret>"
     }
    
  2. Gunakan format Token Web JSON untuk mengenkode string rahasia menjadi JWT.

  3. Tetapkan berikut ini:

    1. ${SECRET} ke string secret
    2. ${ENCODED_SECRET} ke string JWT
    3. ${CPI_ID} ke ID CPI
  4. Validasi identitas dan sertifikasi CPI:

    curl -X POST -H "X-Goog-User-Project: ${CLIENT_PROJECT}" \
      -H "Content-Type: application/json" \
      -H "Authorization: Bearer $TOKEN" \ "https://sasportal.googleapis.com/v1alpha1/installer:validate" \
      -d "{ \"installer_id\": \"${CPI_ID}\", \"secret\": \"${SECRET}\", \"encoded_secret\": \"${ENCODED_SECRET}\" }"
    

Sekarang CPI dapat menginstal Perangkat Layanan Radio Broadband Warga (CBSD) yang memiliki semua parameter yang diperlukan.

Pendaftaran CBSD multi-langkah

Anda dapat melakukan pendaftaran CBSD multilangkah dengan parameter perangkat yang sebelumnya ditandatangani oleh CPI atau dengan akun CPI.

Parameter perangkat yang sebelumnya ditandatangani oleh CPI

Contoh ini menunjukkan cara membuat konfigurasi perangkat tidak aktif dengan parameter penginstalan CBSD yang sebelumnya dienkode oleh CPI. Akibatnya, pengguna non-CPI juga dapat membuat konfigurasi.

  1. Gunakan kunci pribadi CPI untuk mengenkode parameter CBSD. Sebaiknya Anda menggunakan format Token Web JSON.
  2. Tetapkan ${ENCODED_DEVICE} ke string JWT dan ${CPI_ID} ke ID CPI.
  3. Buat konfigurasi perangkat tidak aktif:

    curl -X POST -H "X-Goog-User-Project: ${CLIENT_PROJECT}" \
      -H "Content-Type: application/json" \
      -H "Authorization: Bearer ${TOKEN}" \ "https://sasportal.googleapis.com/v1alpha1/${CUSTOMER_NAME}/devices:createSigned" \
      -d "{ \"installer_id\": \"${CPI_ID}\", \"encoded_device\": \"${ENCODED_DEVICE}\", \"parent\": \"${CUSTOMER_NAME}\" }"
    

CBSD kemudian harus mengirimkan permintaan pendaftaran ke SAS untuk menyelesaikan pendaftarannya.

Akun CPI

Identitas CPI harus divalidasi sebelum Anda memvalidasi konfigurasi perangkat. Setelah selesai, gunakan perintah berikut untuk membuat konfigurasi perangkat yang tidak aktif:

  curl -X POST -H "X-Goog-User-Project: ${CLIENT_PROJECT}" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer $TOKEN" \ "https://sasportal.googleapis.com/v1alpha1/${DEVICE_NAME}:signDevice" \
    -d "${DEVICE}"

Ganti ${DEVICE} dengan representasi JSON dari parameter pendaftaran CBSD. Untuk mengetahui informasi selengkapnya tentang format, lihat Resource REST: customers.devices.

CBSD kemudian harus mengirimkan permintaan pendaftaran ke SAS untuk menyelesaikan pendaftarannya.

Langkah selanjutnya