Kami akan menghentikan On-Premises API. Lihat Proses Penghentian On-Premises API dokumen untuk detailnya, dan untuk mempelajari cara bermigrasi ke Cloud API generasi berikutnya.

Eksternal

/v1/certificates/external

Gunakan edge ini untuk mengunggah, mengambil, menghapus, dan mereset Sertifikat CA (Certificate Authority) Anda.

Sebelum Memulai

Anda harus menggunakan akun admin untuk mengunggah dan menghapus semua sertifikat.

Mengambil

Buat panggilan GET ke endpoint ini untuk mengambil sertifikat CA yang disimpan di klien API WhatsApp Business.

Contoh

Permintaan:

GET /v1/certificates/external/ca

Tanggapan:

Content-Type: text/plain
Content-Length: content-size

certificate

Jika sertifikat CA tidak ditemukan, kode tanggapan 404 dikembalikan tanpa badan.

Mengunggah

Buat panggilan POST untuk mengunggah sertifikat CA. Pastikan sertifikat yang diunggah berisi bagian berikut dalam satu file dan dengan urutan sama seperti yang ditampilkan di sini:

  1. Kunci pribadi
  2. Sertifikat
  3. Satu atau beberapa sertifikat CA menengah — Klien API WhatsApp Business perlu setidaknya satu sertifikat CA menengah, jika tidak, pengunggahan akan gagal.

Contoh

Untuk mengunggah sertifikat ke Klien API WhatsApp Business, gunakan permintaan API berikut, yang berisi Content-Type dari text/plain.

POST /v1/certificates/external
  Content-Type: text/plain
  Content-Length: content-size

certificate

Jika menggunakan cURL, perintahnya seperti ini:

curl -X POST \
  https://your-webapp-hostname:your-webapp-port/v1/certificates/external \
  -H 'Authorization: Bearer your-auth-token' \
  -H 'Content-Type: text/plain' \
  --data-binary @your-path-to-certificate.pem 

Jika sertifikat sudah ada, akan ditimpa. Anda harus memulai ulang server web, yaitu, semua contoh kontainer Webapp, setelah sertifikat diunggah.

Anda harus sangat berhati-hati untuk hanya memperbarui sertifikat dengan sertifikat yang valid (yaitu tepat & benar). Jika tidak, server web akan gagal dimulai ulang (karena endpoint API akan down) dan akan memerlukan intervensi manual untuk pulih dari situasi.

Tanggapan untuk panggilan API Anda terlihat seperti ini:

null

Mereset

Saat mengunggah sertifikat CA ke klien API WhatsApp Business, jika sertifikat tidak valid karena beberapa alasan, kontainer Webapp akan gagal memulai boot ulang karena endpoint API akan mati. Agar pulih dari situasi ini, Anda harus melepaskan tabel database certs database.

Untuk melepaskan tabel database certs:

  1. Menghentikan kontainer Webapp:
    docker stop your-webapp-container-id
  2. Terhubung ke MySQL melalui Docker di baris perintah:
    docker exec -it your-mysql-container-id mysql -uroot -p
  3. Masukkan kata sandi MySQL Anda saat diminta (sesuai mysql.conf).
  4. Periksa apakah tabel certs ada:
    show tables in waweb;
  5. Lepaskan tabel certs:
    drop table waweb.certs;
  6. Keluar MySQL:
    exit;
  7. Mulai ulang kontainer Webapp:
    docker restart your-webapp-container-id
  8. Login ke MySQL lagi menggunakan langkah-langkah di atas untuk memastikan tabel certs sekarang ada.

Menghapus

Menghapus sertifikat tidak didukung. Kami dapat mendukung ini pada masa mendatang jika ada kasus penggunaan yang telah kami abaikan.