REST API v4 Gateway โšก 967 Endpoint ยท ๐Ÿ›๏ธ 6 OPD

Panduan Memulai & Integrasi

Empat langkah praktis dari penerbitan token otentikasi hingga panggilan endpoint API terbuka Kota Samarinda.

๐Ÿ—๏ธ Terbitkan Token Baru โ†’

Alur 4 Langkah Memulai

Ikuti alur sederhana ini untuk mulai mengonsumsi data resmi Pemkot Samarinda.

01๐Ÿ”

Masuk via SSO Samarinda

Portal API terhubung dengan Single Sign-On (SSO) Kota Samarinda. Gunakan akun ASN / Pengembang resmi Anda untuk masuk.

02๐Ÿ—๏ธ

Terbitkan Token & Scope

Buka menu Aplikasi & Token di panel pengembang, buat nama aplikasi, lalu pilih scope dataset yang ingin Anda akses.

03๐Ÿ›ก๏ธ

Simpan Token Rahasia

Token Bearer hanya ditampilkan SEKALI saat penerbitan demi keamanan. Simpan token di brankas rahasia aplikasi Anda.

04โšก

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.

๐Ÿš€Desktop & Web

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
Unduh Postmanโ†—
๐ŸŒ™Open Source

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
Unduh Insomniaโ†—
๐Ÿถ100% Offline / Privasi

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
Unduh Brunoโ†—
โšกBisa via Browser

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
Buka Hoppscotch Webโ†—
๐Ÿ’ปBawaan macOS / Linux / Windows

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
Dokumentasi cURLโ†—
๐Ÿš€

Panduan Cara Menggunakan PostmanPaling Populer

Langkah-langkah praktis menguji endpoint API Samarinda dengan Postman.

Tautan Unduhan Resmi Postmanโ†—

Tahap Konfigurasi & Eksekusi:

1
Unduh & Pasang Postman

Unduh aplikasi Postman Desktop gratis sesuai sistem operasi Anda (Windows, macOS, Linux) melalui tautan unduhan resmi.

2
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.

3
Impor Berkas ke Postman

Buka Postman -> Klik menu "Import" di sudut kiri atas -> Seret (drag & drop) berkas .json yang baru saja Anda unduh.

4
Atur Token Bearer

Buka request yang terimpor -> Tab "Authorization" -> Pilih Type "Bearer Token" -> Tempel Token API yang Anda terbitkan di panel pengembang.

5
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/json
๐Ÿ’ก
Tips 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

200 OK
{
  "status":  "success",
  "message": "Data berhasil dimuat",
  "data":    [ ... ],
  "meta":    { "version": "4.0" }
}
Rate Limit โšก
120 req / menit

Batas ambang pemanggilan per token pengguna.

Masa Berlaku Token โณ
24 Jam

Masa aktif token pengguna demi menjaga keamanan.

Endpoint Privat ๐Ÿ”
44 Endpoint

Khusus aplikasi resmi / pengembang terverifikasi Diskominfo.

๐Ÿข System-to-System OAuth 2.0

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_id dan client_secret resmi atas nama aplikasi.
  • โœ“Audit Logging Terpusat: Setiap jejak permintaan tercatat tepat pada nama aplikasi pemilik rute data.

2. Tahap Pengajuan Kredensial

  1. 1.Ajukan permohonan lewat Hubungi Diskominfo.
  2. 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โ€ฆ" }
โšก High Performance BFF Engine

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-CIRCUIT
๐Ÿงช

BFF, Pipeline & APISIX Playground

LIVE GATEWAY

Uji coba eksekusi agregasi paralel, alur data berantai, routing canary, mock respon, dan simulasi chaos.

POST /gateway/aggregate

Panduan Kode Galat (HTTP Error Status)

Penjelasan ringkas pesan galat standar saat terjadi kendala pemanggilan.

HTTP 401Unauthorized

Token tidak dikirim, salah, atau telah kedaluwarsa (berumur 24 jam).

HTTP 403Error

Token sah tetapi scope-nya tidak mencakup dataset ini, atau endpoint membutuhkan akun pengembang privat.

HTTP 404Not Found

Kombinasi OPD, dataset, atau rute tidak terdaftar di API Gateway. Periksa kembali dokumentasi.

HTTP 429Too Many Requests

Melewati batas 120 permintaan per menit. Harap berikan jeda sebelum memanggil kembali.

HTTP 502 / 504Bad Gateway / Timeout

Server OPD pemilik data sedang tidak merespons. Sistem gateway akan otomatis mencoba ulang.

HTTP 503Service Unavailable

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.

Hubungi Tim Teknis โ†’