Lewati ke konten utama

Announcements & Release Notes

Berbeda dengan Mass Broadcast yang mengirimkan pesan langsung ke kotak masuk email Customer, fitur Announcements dan Release Notes berfungsi sebagai Papan Pengumuman publik yang tayang di halaman utama (Dashboard) web atau aplikasi mobile milik pelanggan.

  • Announcements: Pengumuman penting yang sifatnya mendesak atau komersial (Promo Lebaran, Peringatan Server Down, dsb). Umumnya dirender sebagai Banner besar atau Carousel di beranda pelanggan.
  • Release Notes: Catatan pembaruan teknis (fitur baru, perbaikan bug) yang ditujukan agar pelanggan mengetahui evolusi platform Frog Cloud.

Siklus hidup dokumen ini mengikuti konsep CMS (Content Management System), yakni memiliki fase Draft (belum tayang) dan Published (sedang tayang).

Diagram Siklus Hidup Publikasi​

1. Manajemen Announcements (Backoffice)​

Semua operasi CRUD untuk Pengumuman dikelola melalui path /api/backoffice/announcements.

Pembuatan dan Perubahan Draf​

Admin membuat konten pengumuman baru dengan memberikan Judul dan Isi Pesan. Dokumen baru secara otomatis berstatus draf.

  • Get All: GET /api/backoffice/announcements
  • Create: POST /api/backoffice/announcements
  • Update: PUT /api/backoffice/announcements/{id}
  • Delete: DELETE /api/backoffice/announcements/{id}

Publikasi (Publish / Unpublish)​

Hanya pengumuman yang di-publish yang akan terlihat oleh pelanggan. Jika masa promo sudah habis, Admin wajib menekan tombol Unpublish.

  • Tayangkan (Publish): POST /api/backoffice/announcements/{id}/publish
  • Tarik Mundur (Unpublish): POST /api/backoffice/announcements/{id}/unpublish

2. Manajemen Release Notes (Backoffice)​

Pola kerja Release Notes sama persis dengan Announcements, perbedaannya hanya pada letak URL dan cara perenderan di sisi Frontend Customer (biasanya dirender sebagai senarai waktu / Timeline).

  • CRUD Operations: /api/backoffice/release-notes
  • Publish: POST /api/backoffice/release-notes/{id}/publish
  • Unpublish: POST /api/backoffice/release-notes/{id}/unpublish

Catatan Integrasi: Untuk panduan implementasi di sisi Customer Web / Mobile Application (pemanggilan endpoint GET /api/announcements/highlight dan GET /api/release-notes), silakan merujuk ke dokumen Informasi & Pembaruan pada direktori dokumentasi Customer.