API Documentation

Dokumentasi API

Dokumentasi lengkap untuk mengakses data PPID Kabupaten Hulu Sungai Tengah

Tentang API PPID

Dokumentasi API ini disediakan dalam rangka mendukung keterbukaan informasi publik sesuai dengan Undang-Undang Keterbukaan Informasi Publik. API ini dapat digunakan oleh OPD Pelaksana untuk mengembangkan aplikasi informasi PPID mereka sendiri, sehingga tercipta satu pintu informasi terpadu dalam satu server Dinas Komunikasi dan Informatika Kabupaten Hulu Sungai Tengah.

Tujuan

Mendukung implementasi keterbukaan informasi publik secara digital
Memudahkan OPD dalam mengelola dan mempublikasikan informasi
Menciptakan sistem informasi PPID yang terintegrasi
Meningkatkan aksesibilitas informasi publik

Fitur Utama

Endpoint untuk mengakses daftar informasi publik
Filter berdasarkan jenis informasi dan OPD pelaksana
Pencarian informasi berdasarkan kata kunci
Pagination untuk mengelola data dalam jumlah besar

Persyaratan Penggunaan

Method GET

Dapat digunakan secara langsung
Tidak memerlukan autentikasi
Rate limit: 60 request per menit per IP

Method POST

Wajib mengajukan permohonan terlebih dahulu
Memerlukan autentikasi
Rate limit: 30 request per menit per IP

Cara Pengajuan Akses POST dengan mendapatkan akses APIKey

ppid@hstkab.go.id

Surat tertulis ditujukan kepada Kepala Dinas Komunikasi dan Informatika Kabupaten Hulu Sungai Tengah

Base URL API

https://ppid.hstkab.go.id/api/getDaftarInformasi

Rate Limit

60 request per menit per IP

GET

https://ppid.hstkab.go.id/api/getDaftarInformasi

Mendapatkan semua daftar informasi yang dipublikasikan

Parameter

Nama	Tipe	Default	Deskripsi
limit	`number`	10	Jumlah data yang akan diambil
offset	`number`	0	Offset untuk pagination
search opsional	`string`	-	Kata kunci pencarian dalam judul
jenis opsional	`string (UUID)`	-	Filter berdasarkan jenis informasi
pelaksana opsional	`string (UUID)`	-	Filter berdasarkan OPD pelaksana

Response

{
  "data": [
    {
      "id": "uuid",
      "judul": "Judul Informasi",
      "deskripsi": "Deskripsi informasi",
      "jenis": "uuid-jenis-informasi",
      "pelaksana": "uuid-opd-pelaksana",
      "jenis_informasi": {
        "id": "uuid",
        "nama": "Nama Jenis Informasi"
      },
      "opd_pelaksana": {
        "id": "uuid",
        "name_opd": "Nama OPD"
      }
    }
  ],
  "count": 100
}

Contoh Penggunaan

Filter Berdasarkan OPD Pelaksana

Anda dapat mengambil daftar informasi yang hanya dikelola oleh OPD tertentu dengan menambahkan parameter pelaksana (UUID OPD pelaksana) pada query string endpoint ini.

Ganti UUID_OPD dengan UUID dari OPD pelaksana yang diinginkan. Anda dapat memperoleh daftar UUID OPD pelaksana melalui endpoint OPD Pelaksana di sidebar.