Panduan Memulai & Integrasi
Empat langkah praktis dari penerbitan token otentikasi hingga panggilan endpoint API terbuka Kota Samarinda.
Alur 4 Langkah Memulai
Ikuti alur sederhana ini untuk mulai mengonsumsi data resmi Pemkot Samarinda.
Masuk via SSO Samarinda
Portal API terhubung dengan Single Sign-On (SSO) Kota Samarinda. Gunakan akun ASN / Pengembang resmi Anda untuk masuk.
Terbitkan Token & Scope
Buka menu Aplikasi & Token di panel pengembang, buat nama aplikasi, lalu pilih scope dataset yang ingin Anda akses.
Simpan Token Rahasia
Token Bearer hanya ditampilkan SEKALI saat penerbitan demi keamanan. Simpan token di brankas rahasia aplikasi Anda.
Panggil REST Endpoint
Gunakan header Authorization Bearer TOKEN_ANDA pada rute API Gateway resmi sesuai rincian di katalog dokumentasi.
Perangkat Lunak Pengujian API (API Tools & Cara Penggunaan)
Pilihan aplikasi pengujian API populer, tautan unduhan resmi, serta panduan praktis pengaturan Token Bearer untuk menguji endpoint Kota Samarinda.
Postmanโ Aktif
Platform pengujian API nomor 1 dunia. Sangat disarankan untuk menguji koleksi endpoint API Samarinda dengan fitur import collection v2.1 sekali klik.
- โImport Postman Collection v2.1 bawaan portal
- โEnvironment Variable {{TOKEN_ANDA}} otomatis
- โAutomated Test Runner & Visualizer
Insomnia REST Client
Aplikasi pengujian API desktop yang bersih, modern, dan sangat cepat dari Kong. Sangat cocok dengan berkas spesifikasi OpenAPI 3.0.
- โImport langsung OpenAPI 3.0 Spec (.json)
- โDukungan Environment & Cookie Manager
- โRingan dengan antarmuka elegan
Bruno API Client
Klien API generasi baru open-source yang sepenuhnya offline, tanpa cloud lock-in, dan menyimpan koleksi dalam format teks biasa (Bru DSL) yang ramah Git.
- โ100% Data tersimpan di disk lokal (aman)
- โBisa di-commit ke Git bersama tim
- โBebas akun cloud
Hoppscotch (Web Based)
Klien API open-source berbasis web super ringan. Anda dapat langsung menggunakannya tanpa perlu mengunduh atau memasang software apa pun.
- โLangsung jalan di Browser web
- โPWA & Progressive Web App
- โDukungan REST, GraphQL, WebSocket
cURL / Terminal CLI
Perangkat bawaan terminal di semua sistem operasi modern. Sangat praktis untuk pengujian cepat, cron script, atau integrasi server CI/CD.
- โSudah terpasang di OS
- โIdeal untuk otomatisasi bash / shell
- โTanpa antarmuka grafis yang berat
Panduan Cara Menggunakan PostmanPaling Populer
Langkah-langkah praktis menguji endpoint API Samarinda dengan Postman.
Tahap Konfigurasi & Eksekusi:
Unduh & Pasang Postman
Unduh aplikasi Postman Desktop gratis sesuai sistem operasi Anda (Windows, macOS, Linux) melalui tautan unduhan resmi.
Unduh Postman Collection dari Portal
Buka halaman rincian endpoint yang ingin diuji di portal ini (misal: Berita Kominfo), lalu klik tombol kuning "Postman" di sudut kanan atas untuk mengunduh berkas .json koleksi.
Impor Berkas ke Postman
Buka Postman -> Klik menu "Import" di sudut kiri atas -> Seret (drag & drop) berkas .json yang baru saja Anda unduh.
Atur Token Bearer
Buka request yang terimpor -> Tab "Authorization" -> Pilih Type "Bearer Token" -> Tempel Token API yang Anda terbitkan di panel pengembang.
Klik Send & Lihat Hasil Data
Tekan tombol biru "Send". Respon payload JSON resmi dari Pemkot Samarinda akan langsung tampil beserta status HTTP 200 OK dan waktu latensi (ms).
Contoh Cuplikan Konfigurasi Header:
// Konfigurasi Header di Postman:
Authorization: Bearer <TOKEN_API_SAMARINDA_ANDA>
Accept: application/jsonTips Ekspor Cepat dari Portal:
Di setiap halaman detail endpoint (seperti Katalog Berita), terdapat tombol siap-pakai Postman Collection dan OpenAPI 3.0 yang bisa langsung Anda unduh dan impor ke aplikasi klien API Anda.
Contoh Pemanggilan Multi-Bahasa Pemrograman
Salin kode pemanggilan instan dalam berbagai bahasa pemrograman populer.
curl -X GET \
'https://api.samarindakota.go.id/api/v4/gateway/dinas-komunikasi-dan-informatika/berita-konten-portal/berita' \
-H 'Authorization: Bearer TOKEN_ANDA' \
-H 'Accept: application/json'Format Tanggapan (JSON Payload)
Struktur balasan standar untuk seluruh rute
{
"status": "success",
"message": "Data berhasil dimuat",
"data": [ ... ],
"meta": { "version": "4.0" }
}Batas ambang pemanggilan per token pengguna.
Masa aktif token pengguna demi menjaga keamanan.
Khusus aplikasi resmi / pengembang terverifikasi Diskominfo.
Integrasi Antar-Aplikasi Pemerintah (Server-to-Server)
Untuk aplikasi internal Pemkot Samarinda (seperti portal dinas, SSO, atau backend instansi) yang membutuhkan akses otomatis tanpa interaksi pengguna manusia.
1. Mengapa Menggunakan Client Credentials?
- โToken Sistem Berkelanjutan: Menggunakan
client_iddanclient_secretresmi atas nama aplikasi. - โAudit Logging Terpusat: Setiap jejak permintaan tercatat tepat pada nama aplikasi pemilik rute data.
2. Tahap Pengajuan Kredensial
- 1.Ajukan permohonan lewat Hubungi Diskominfo.
- 2.Dapatkan pasangan Kredensial Rahasia (
client_secret).
Penukaran Kredensial ke Token OAuth:
curl -X POST https://api.samarindakota.go.id/oauth/token \
-d 'grant_type=client_credentials' \
-d 'client_id=ID_APLIKASI_ANDA' \
-d 'client_secret=RAHASIA_APLIKASI_ANDA' \
-d 'scope=*'
# Respons Token OAuth:
{ "token_type": "Bearer", "expires_in": 86400, "access_token": "eyJ0โฆ" }Agregasi Data Paralel & Ketahanan Sirkuit (BFF & Circuit Breaker)
API Gateway Samarinda dilengkapi mesin Backend-for-Frontend (BFF) untuk memanggil banyak endpoint OPD secara paralel dalam 1 kali round-trip HTTP, dilengkapi pemutus sirkuit otomatis dan sensor data pribadi (UU PDP).
1. Panggilan Batch Paralel (POST /aggregate)
Kirimkan daftar endpoint yang ingin diambil sekaligus. Gateway akan mengeksekusi request ke seluruh server OPD secara non-blocking bersamaan, menyaring data sensitif, dan mengembalikan 1 payload terpadu.
curl -X POST https://api.samarindakota.go.id/api/v4/gateway/aggregate \
-H 'Authorization: Bearer TOKEN_ANDA' \
-H 'Content-Type: application/json' \
-d '{
"strategy": "keyed",
"requests": [
{ "alias": "sekolah", "opd": "dinas-pendidikan", "dataset": "data-sekolah", "path": "" },
{ "alias": "puskesmas", "opd": "dinas-kesehatan", "dataset": "fasilitas-kesehatan", "path": "puskesmas" }
]
}'2. Preset Siap Pakai & Circuit Breaker
Akses endpoint preset instan seperti ringkasan-kota atau fasilitas-publik. Jika salah satu server OPD mengalami gangguan, Circuit Breaker otomatis menyajikan Stale-Cache tanpa mengunci aplikasi Anda.
curl -X GET \
https://api.samarindakota.go.id/api/v4/gateway/preset/ringkasan-kota \
-H 'Authorization: Bearer TOKEN_ANDA'
# Header status pemutus sirkuit:
X-Cache: HIT | STALE-CIRCUITBFF, Pipeline & APISIX Playground
LIVE GATEWAYUji coba eksekusi agregasi paralel, alur data berantai, routing canary, mock respon, dan simulasi chaos.
Panduan Kode Galat (HTTP Error Status)
Penjelasan ringkas pesan galat standar saat terjadi kendala pemanggilan.
Token tidak dikirim, salah, atau telah kedaluwarsa (berumur 24 jam).
Token sah tetapi scope-nya tidak mencakup dataset ini, atau endpoint membutuhkan akun pengembang privat.
Kombinasi OPD, dataset, atau rute tidak terdaftar di API Gateway. Periksa kembali dokumentasi.
Melewati batas 120 permintaan per menit. Harap berikan jeda sebelum memanggil kembali.
Server OPD pemilik data sedang tidak merespons. Sistem gateway akan otomatis mencoba ulang.
Gerbang membatasi sementara koneksi ke server OPD yang mengalami kegagalan beruntun.
Ada Pertanyaan atau Kendala Integrasi?
Tim teknis Diskominfo Kota Samarinda siap membantu verifikasi scope dan masalah akses data Anda.
