Meta Data Dokumen

Konsep E-GIFT

e-GIFT didefinisikan sebagai seperangkat standar dan pedoman yang menetapkan bahasa umum untuk mengatur pertukaran informasi antar sistem SPBE di lingkungan Pemerintah Kabupaten Tasikmalaya. Standar-standar ini membentuk dasar perancangan layanan e-government agar pemerintah, perusahaan, dan warga dapat berinteraksi secara efisien. Dengan demikian, e-GIFT merupakan salah satu sarana untuk mencapai tujuan integrasi data e-government.

Tujuan E-GIFT

1. Memberikan latar belakang mengenai isu dan tantangan dalam membangun interoperabilitas dan berbagi informasi di antara Aplikasi SPBE.
2. Menjelaskan pendekatan untuk mengatasi tantangan-tantangan ini; menetapkan konsep yang disepakati bersama untuk dipahami secara seragam.
3. Menawarkan rekomendasi spesifik yang dapat diadopsi oleh berbagai pemangku kepentingan.

Target Stakeholders

Target stakeholders meliputi:

1. K/L (Kementerian / Lembaga Pusat)
2. SKPD dan pengambil keputusan di lingkungan Pemerintah Kabupaten Tasikmalaya
3. Penyedia Layanan Elektronik
4. Masyarakat luas sebagai pengguna layanan SPBE
5. Industri TIK
6. Akademisi dan Lembaga Penelitian

Standar E-GIFT

Dokumen ini mendefinisikan kebijakan dan spesifikasi teknis yang mengatur arus informasi lintas pemerintahan dan sektor publik, termasuk interkonektivitas, integrasi data, akses layanan elektronik, dan manajemen konten. Elemen kunci: seperangkat standar data yang disepakati (Katalog Standar Data Pemerintah).

Target E-GIFT

Target utama E-GIFT mengacu pada Indonesian e-Government Interoperability Framework (e-IGIF) yaitu berfokus pada membangun interoperabilitas G2G (Government-to-Government), dengan model pada gambar 1.

Diagram target E-GIFT memperlihatkan bahwa interoprabilitas data e-Government memiliki target untuk meningkatkan layanan pemerintahan di Kabupaten Tasikmalaya secara digital. Dokumen standar E-GIFT menjadi pedoman teknis dalam pemerintahan digital untuk layanan interoprabilitas data (Tasik Satu Data/TSD) menuju Satu Data Indonesia (SDI). Integrasi aplikasi dan platform terlihat pada bagian G2G antara SKPD dan Kementerian/Lembaga (K/L).
Sedangkan target pelaksanaan teknis E-GIFT memiliki model yang disajikan pada gambar berikut

Pada gambar diatas dijelasakan bahwa e-GIFT menjadi sebuah standar dalam melakukan komunikasi data antara aplikasi SPBE yang digunakan di Kabupaten Tasikmalaya melalui interoperabilitas semantik dan teknis. Application Programming Interface (API) harus disediakan pada setiap aplikasi SPBE mengacu pada standar-standar yang ditetapkan pada e-GIFT.

Web App adalah perangkat lunak (software) yang berbasis web, artinya dapat diakses hanya dengan menggunakan browser saja, dan tersimpan pada server yang dikirimkan melalui internet. Layanan web app memungkinkan adanya interaksi di dalam website dari pengguna kepada pemilik dari web tersebut berupa pengiriman data dan informasi.

Mobile App merupakan perangkat lunak berupa aplikasi yang memang dikembangkan untuk menggunakan program komputerisasi yang disematkan pada perangkat mobile seperti ponsel, tablet atau bahkan jam tangan digital. Aplikasi mobile adalah solusi teknologi yang memungkinkan penggunanya untuk mengakses berbagai informasi dan layanan dengan mudah, hanya melalui sentuhan jari. Perkembangan aplikasi mobile telah merubah cara kita berinteraksi dengan dunia digital, menawarkan kemudahan dan kecepatan dalam berbagai aktivitas, dari yang sederhana seperti memesan makanan hingga yang kompleks seperti analisis data bisnis.

Desktop App adalah program perangkat lunak yang dijalankan secara lokal di perangkat komputer. Tidak seperti aplikasi berbasis web, aplikasi desktop tidak dapat diakses dari browser dan memerlukan instalasi di komputer pribadi atau laptop.Web app, mobile app dan desktop app masing-masing memiliki database sebagai pengelolaan data dengan standar DBMS (DataBase Management System), dalam konteks interoperabilitas data, setiap aplikasi SBPE baik berbasis web app, mobile app dan desktop app harus saling berbagi pakai data, sehinggal harus dibuatkan API. API menjadi penghubung komunikasi dalam interoprabilitas data e-Government. Sedangkan API Gateway merupakan API manajemen yang bertindak sebagai perantara antara klien API dan layanan backend.

#Prinsip Interoperabilitas

Prinsip-prinsip utama yang mendasari e-GIFT mencakup beberapa aspek agar interoperabilitas berjalan efektif dan aman.

Keterbukaan

Dalam layanan publik yang interoperabilitas, konsep keterbukaan terutama berkaitan dengan data, spesifikasi, dan perangkat lunak. Data pemerintah terbuka (disini disebut 'opendata') mengacu pada gagasan bahwa semua data publik harus tersedia secara bebas untuk digunakan dan digunakan kembali oleh orang lain, kecuali jika terdapat pembatasan, misalnya untuk perlindungan data pribadi, kerahasiaan, atau hak kekayaan intelektual.

Transparan

Prinsip Transparansi dalam konteks e-GIFT mengacu pada :

1. Memungkinkan visibilitas di dalam lingkungan administratif SKPD. Ini berarti memungkinkan SKPD, masyarakat, dan pelaku bisnis untuk melihat dan memahami aturan, proses, data, layanan, dan pengambilan keputusan administratif;
2. Memastikan ketersediaan antarmuka dengan sistem informasi internal. SKPD seringkali mengoperasikan banyak sistem informasi yang heterogen dan berbeda untuk mendukung proses internal mereka. Interoperabilitas bergantung pada ketersediaan antarmuka untuk sistem-sistem ini dan data yang ditanganinya. Interoperabilitas pada gilirannya memfasilitasi penggunaan kembali aplikasi SPBE dan data, serta memungkinkan integrasinya ke dalam aplikasi SPBE yang lebih besar; dan
3. Menjamin hak atas perlindungan data pribadi, dengan menghormati Standar hukum yang berlaku untuk sejumlah besar data pribadi masyarakat, yang dipegang dan dikelola oleh SKPD.

Re-usability

Penggunaan kembali berarti bahwa SKPD yang dihadapkan pada masalah tertentu berupaya mengambil manfaat dari aplikasi SPBE lain dengan melihat apa yang tersedia, menilai kegunaan atau relevansinya dengan masalah yang dihadapi, dan jika sesuai, mengadopsi solusi yang telah terbukti bermanfaat di tempat lain. Hal ini mengharuskan SKPD untuk terbuka dalam berbagi solusi interoperabilitas, konsep, Standar, spesifikasi, perangkat, dan komponennya dengan pihak lain.

Netralitas Teknologi dan Portabilitas Data

Dalam membangun layanan e-Government, SKPD harus berfokus pada kebutuhan fungsional dan menunda keputusan terkait teknologi selama mungkin. Hal ini akan meminimalkan ketergantungan teknologi, menghindari penerapan implementasi atau produk teknis tertentu kepada konstituennya, dan mampu beradaptasi dengan lingkungan teknologi yang berkembang pesat. SKPD harus menyediakan akses dan penggunaan kembali layanan dan data publik mereka, terlepas dari teknologi atau produk tertentu.

User-Centricity

Pengguna layanan e-Government adalah setiap SKPD, masyarakat, atau badan usaha yang mengakses dan/atau memperoleh manfaat dari layanan ini. Kebutuhan pengguna harus dipertimbangkan ketika menentukan layanan yang akan disediakan dan bagaimana layanan tersebut akan diberikan. Oleh karena itu, sedapat mungkin, kebutuhan dan persyaratan pengguna harus memandu perancangan dan pengembangan layanan, sesuai dengan hal-hal berikut:

1. Pendekatan penyediaan layanan multi-saluran, yang berarti tersedianya saluran alternatif, baik fisik maupun digital, untuk mengakses suatu layanan, merupakan bagian penting dari desain layanan publik, karena pengguna mungkin lebih menyukai saluran yang berbeda-beda, tergantung pada keadaan dan kebutuhan mereka;
2. Satu titik kontak tunggal harus tersedia bagi pengguna, untuk menyembunyikan kompleksitas administratif internal dan memfasilitasi akses ke layanan publik, misalnya ketika beberapa lembaga harus bekerja sama untuk menyediakan layanan publik;
3. Umpan balik pengguna harus dikumpulkan, dievaluasi, dan digunakan secara sistematis untuk merancang layanan publik baru dan untuk lebih meningkatkan layanan yang sudah ada;
4. Sejauh memungkinkan, berdasarkan undang-undang yang berlaku, pengguna harus dapat memberikan data satu kali saja, dan administrasi harus dapat mengambil dan membagikan data ini untuk melayani pengguna, sesuai dengan aturan perlindungan data;
5. Pengguna harus diminta untuk hanya memberikan informasi yang diperlukan untuk mendapatkan layanan publik tertentu.

Security and Privacy

Masyarakat dan pelaku bisnis harus yakin bahwa ketika berinteraksi dengan otoritas publik, mereka melakukannya dalam lingkungan yang aman dan tepercaya serta sepenuhnya mematuhi peraturan terkait seperti Undang-Undang Perlindungan Data dan Privasi. SKPD harus menjamin privasi, kerahasiaan, keaslian, integritas, dan kerahasiaan informasi yang diberikan oleh warga negara dan pelaku bisnis.

Administrative Simplification

Jika memungkinkan, SKPD harus berupaya menyederhanakan dan merampingkan proses administratif mereka dengan meningkatkannya atau menghilangkan proses yang tidak memberikan nilai publik. Penyederhanaan administratif dapat membantu pelaku bisnis dan warga negara mengurangi beban administratif dalam mematuhi peraturan pemerintah atau kewajiban nasional. Demikian pula, SKPD harus memperkenalkan layanan publik yang didukung oleh sarana elektronik, termasuk interaksi mereka dengan SKPD lain, warga negara, dan pelaku bisnis.

Data Retention

Peraturan perundang-undangan mewajibkan keputusan dan data disimpan dan dapat diakses selama jangka waktu tertentu. Ini berarti bahwa catatan dan informasi elektronik yang disimpan oleh SKPD untuk tujuan mendokumentasikan prosedur dan keputusan harus dilestarikan dan, jika perlu, dikonversi ke media baru ketika media lama sudah usang. Tujuannya adalah untuk memastikan bahwa catatan dan bentuk informasi lainnya tetap terjaga keterbacaannya, keandalannya, dan integritasnya serta dapat diakses kapan pun diperlukan dengan tunduk pada ketentuan keamanan dan privasi.

Penilaian Efektivitas dan Efisiensi

Ada banyak cara untuk menilai nilai layanan e-Government yang interoperabel, termasuk pertimbangan seperti laba atas investasi, total biaya kepemilikan, tingkat fleksibilitas dan adaptabilitas, pengurangan beban administratif, efisiensi, pengurangan risiko, transparansi, penyederhanaan, peningkatan metode kerja, dan tingkat kepuasan pengguna. Berbagai solusi teknologi perlu dievaluasi untuk memastikan efektivitas dan efisiensi layanan e-Government.

#Lapisan Interoperabilitas

Ini menjelaskan model interoperabilitas yang berlaku untuk semua layanan e-Government dan juga dapat dianggap sebagai elemen integral dari paradigma interoperabilitas berdasarkan desain. Model ini mencakup:

1. Empat lapisan interoperabilitas: hukum, organisasi, semantik, dan teknis;
2. Komponen lintas sektor dari keempat lapisan tersebut, ‘layanan pemerintahan terpadu’; dan
3. Lapisan latar belakang, ‘tata kelola interoperabilitas’

Interoperabilitas Hukum / Legal

Setiap SKPD yang berkontribusi pada penyediaan layanan e-Government harus beroperasi dalam Standar Hukum sektornya masing-masing. Interoperabilitas hukum bertujuan untuk memastikan bahwa organisasi yang beroperasi di bawah Standar Hukum, kebijakan, dan strategi yang berbeda dapat bekerja sama. Hal ini mungkin mensyaratkan bahwa undang-undang tidak menghalangi pembentukan layanan publik di dalam dan di antara SKPD dan adanya kesepakatan yang jelas tentang cara menangani perbedaan undang-undang lintas sektor, termasuk opsi untuk membentuk undang-undang baru.

Interoperabilitas Kelembagaan

Hal ini mengacu pada cara SKPD menyelaraskan proses bisnis, tanggung jawab, dan ekspektasi mereka untuk mencapai tujuan yang disepakati bersama dan saling menguntungkan. Dalam praktiknya, interoperabilitas kelembagaan berarti mendokumentasikan dan mengintegrasikan atau menyelaraskan proses bisnis dan informasi relevan yang dipertukarkan. Interoperabilitas kelembagaan juga bertujuan untuk memenuhi kebutuhan komunitas pengguna dengan menyediakan layanan yang mudah diakses, mudah diidentifikasi, dan berfokus pada pengguna. Analisa berdasarkan keberagaman organisasi/Perangkat Daerah yang memiliki keterkaitan visi misi, kepentingan dan tupoksi, adapun komponen-komponen adalah

1. Kebutuhan Regulasi/kebijakan yang mendeskripsikan kesepakatan dalan bertukar data secara bersama, dan mendeskripsikan penggunaan infrastruktur bersama.
2. Regulasi Standar Data yaitu penetapan standar data dari meta-data yang akan digunakan ke dalam struktur data master yang akan digunakan
3. Kebutuhan Bertukar Data yaitu kebutuhan data yang dapat diakses secara bersamaan oleh beberapa pengguna Perangkat Daerah.
4. Ketersediaan Data: yaitu ketersediaan data sharing dalam bentuk digital, file, database dan lain-lain.

Interoperabilitas Semantik

Interoperabilitas semantik memastikan bahwa format dan makna yang tepat dari data dan informasi yang dipertukarkan tetap terjaga dan dipahami selama pertukaran antar pihak, dengan kata lain 'apa yang dikirim adalah apa yang dipahami'. Dalam eGIF, interoperabilitas data mencakup aspek semantik dan sintaksis:

1. Aspek semantik mengacu pada makna elemen data dan hubungan di antara mereka. Ini mencakup pengembangan kosakata dan skema untuk menggambarkan pertukaran data, dan memastikan bahwa elemen data dipahami dengan cara yang sama oleh semua pihak yang berkomunikasi; dan
2. Aspek sintaksis mengacu pada penggambaran format informasi yang akan dipertukarkan secara tepat dalam hal tata bahasa dan format.

Titik awal untuk meningkatkan interoperabilitas data adalah dengan memandang data dan informasi sebagai aset publik yang berharga. Analisa berdasarkan keberagaman data elektronik yang berupa sintaks, struktur dan semantik, adapun komponen-komponen adalah

1. Konsistensi Data yaitu tingkat konsistensi dan kevalidan data yang yang dapat dipertanggung jawabkan pada pemilik data utama/master.
2. Pemetaan Data yaitu pemetaan eksternal-konseptual pada DBMS dengan memetakan field-field dan metadata dari user-view ke dalam struktur data yang sesungguhnya. Pemetaan konseptual-internal, DBMS dapat menemukan rekaman fisik dari data yang didefinisikan pada struktur logik.
3. Regulasi Standar Data yaitu penetapan standar data dari meta-data yang akan digunakan ke dalam struktur data master yang akan digunakan.

Interoperabilitas Teknis

Ini mencakup aplikasi dan infrastruktur yang menghubungkan sistem dan layanan. Aspek interoperabilitas teknis meliputi spesifikasi antarmuka, layanan interkoneksi, layanan integrasi data, penyajian dan pertukaran data, serta protokol komunikasi yang aman.
Kendala utama interoperabilitas muncul dari aplikasi SPBE lama. Secara historis, aplikasi SPBE di SKPD dikembangkan secara bottom-up, mencoba memecahkan masalah spesifik domain dan lokal. Hal ini mengakibatkan silo TIK yang terfragmentasi dan sulit untuk saling beroperasi. Interoperabilitas teknis harus dipastikan, jika memungkinkan, melalui penggunaan spesifikasi teknis formal.
Berdasarkan pada arsitektur aplikasi SPBE terdapat 186 aplikasi yang dipergunakan di Kabupaten Tasikmalaya, dengan daftar katalog aplikasi yang terlampir pada e-GIFT ini.

Layanan Interkoneksi (API)

API (Application Programming Interface) adalah seperangkat aturan, protokol, dan alat yang memungkinkan berbagai perangkat lunak atau aplikasi untuk berkomunikasi dan berinteraksi satu sama lain. API bertindak sebagai perantara antara berbagai komponen perangkat lunak, memungkinkan mereka untuk saling berbicara dan berbagi data dengan cara yang terstruktur dan terstandarisasi. Beberapa karakteristik umum dari API adalah sebagai berikut :

1. Standarisasi: API didefinisikan dengan cara yang konsisten dan terstandarisasi. Ini memudahkan penggunaan dan integrasi dengan aplikasi lain, karena pengembang hanya perlu mengikuti aturan yang sudah ditetapkan.
2. Pemisahan antarmuka dan implementasi: API menyediakan antarmuka yang jelas dan terdefinisi dengan baik untuk berinteraksi dengan aplikasi tanpa mengungkapkan detail implementasinya. Hal ini memungkinkan pengembang untuk menggunakan fungsionalitas tanpa harus tahu bagaimana fungsi tersebut diimplementasikan di dalam aplikasi.
3. Pengamanan: API dapat menentukan aksesibilitas dan izin terhadap layanan atau data tertentu, sehingga mengontrol siapa yang dapat menggunakan fungsionalitas tertentu.
4. Versi dan Backward Compatibility: API yang baik biasanya mempertimbangkan versi dan kompatibilitas mundur (backward compatibility) untuk memastikan bahwa perubahan atau pembaruan di masa depan tidak mempengaruhi aplikasi yang telah menggunakan API tersebut.
5. Dokumentasi: API harus didokumentasikan dengan baik, menjelaskan setiap fungsi, parameter, dan output yang diharapkan. Dokumentasi yang baik memudahkan penggunaan dan pengembangan aplikasi yang mengandalkan API tersebut.

Standar API e-GIFT

Standar API adalah merupakan hal yang penting dalam pengembangan perangkat lunak dan aplikasi, terutama jika API tersebut akan digunakan oleh banyak pengembang atau aplikasi pihak ketiga. Standar API yang baik membantu memastikan konsistensi, interoperabilitas, keamanan, dan kemudahan penggunaan. Berikut adalah beberapa hal yang harus diperhatikan dalam standar API data e-Government:

1. Dokumentasi yang Lengkap: Sediakan dokumentasi yang jelas dan komprehensif tentang API, termasuk informasi tentang setiap endpoint, parameter, tipe data yang digunakan, dan respons yang diharapkan. Dokumentasi yang baik membantu pengguna API untuk memahami cara menggunakan API dengan benar.
2. Versi API: Pertimbangkan untuk menyediakan versi API agar dapat mengelola perubahan di masa depan tanpa mengganggu aplikasi yang telah mengintegrasikan versi sebelumnya. Menyediakan versi API juga memungkinkan pengguna untuk memilih menggunakan versi yang paling sesuai dengan kebutuhan mereka.
3. Autentikasi dan Otorisasi: Pertimbangkan metode autentikasi yang aman untuk mengamankan API. Otorisasi juga diperlukan untuk mengatur izin akses pengguna terhadap fitur atau data tertentu.
4. Format Data yang Konsisten: Gunakan format data yang konsisten yaitu JSON untuk mengirim dan menerima data. JSON lebih populer karena ringan dan mudah dibaca oleh manusia dan komputer.
5. Penamaan Endpoints yang Deskriptif: Berikan nama endpoint yang deskriptif dan intuitif agar mudah dimengerti oleh pengguna API.
6. Manajemen Kesalahan yang Baik: Sediakan respons kesalahan yang jelas dan informatif, termasuk kode status HTTP dan pesan kesalahan yang dapat membantu pengguna API memahami penyebab kesalahan dan langkah selanjutnya.
7. Rate Limiting: Pertimbangkan untuk memberlakukan batas penggunaan API (rate limiting) untuk menghindari penggunaan yang berlebihan dan menjaga performa server. Contohnya adalah pembatasan permintaan dalam waktu tertentu. Misalnya 1 request per menit.
8. Handling Versi Depan: Ketika Anda memutuskan untuk mengubah API atau mengeluarkan versi baru, pikirkan juga tentang bagaimana menangani versi yang lebih lama dan memberikan notifikasi kepada pengguna tentang pembaruan tersebut.
9. CORS (Cross-Origin Resource Sharing): Jika API akan digunakan oleh aplikasi web yang diakses dari domain yang berbeda, pastikan untuk mengatur kebijakan CORS dengan benar agar permintaan lintas domain dapat dilakukan dengan aman.
10. Pengujian yang Intensif: Pastikan API telah diuji secara menyeluruh untuk memastikan kestabilan dan kinerja yang baik sebelum dirilis untuk digunakan.
11. Monitoring dan Logging: Sediakan mekanisme untuk memantau penggunaan API, termasuk logging untuk memudahkan pemecahan masalah jika terjadi masalah.
12. Keberlanjutan: Pertimbangkan untuk mendukung dan merawat API secara berkelanjutan untuk memastikan stabilitas dan ketersediaan jangka panjang.
13. Protokol: Gunakan protokol HTTPS (Hypertext Transfer Protocol Secure): komunikasi antara klien dengan server akan dienkripsi sehingga meningkatkan keamanan dalam pertukaran data.

Perjanjian Interoperabilitas

Di tingkat hukum, perjanjian interoperabilitas dinyatakan secara konkret dan mengikat melalui peraturan perundang-undangan, termasuk arahan kebijakan dan transposisinya ke dalam peraturan perundang-undangan nasional, yang detailnya berada di luar cakupan e-GIFT.

Di tingkat organisasi, perjanjian interoperabilitas dapat berupa Nota Kesepahaman (MoU) atau SLA yang menetapkan kewajiban masing-masing pihak yang berpartisipasi dalam proses bisnis lintas sektor.

Perjanjian interoperabilitas di tingkat organisasi akan menentukan tingkat layanan yang diharapkan, prosedur dukungan/eskalasi, detail kontak, dll., dengan merujuk, jika perlu, pada perjanjian yang mendasarinya di tingkat semantik dan teknis. Di tingkat semantik, perjanjian interoperabilitas dapat berupa, antara lain, referensi taksonomi, skema, daftar kode, kamus data, atau pustaka berbasis sektor.

Di tingkat teknis, perjanjian interoperabilitas akan mencakup hal-hal seperti protokol komunikasi, spesifikasi pengiriman pesan, format data, spesifikasi keamanan atau registrasi dinamis dan spesifikasi penemuan layanan.

Arsitektur E-GIFT

Gambaran arsitektur e-GIFT dapat disajikan pada gambar berikut :

Aristektur E-GIFT menggunakan 2 tier yang terdiri dari front-end atau presentation layer dan Back-end.

Roadmap Implementasi E-GIFT

Untuk mengimplementasikan E-GIFT di Pemerintah Kabupaten Tasikmalaya, diperlukan pentahapan implementasi untuk meminimalisir resiko kegagalan implementasi. Selain itu juga diperlukan proses pemetaan prioritas untuk penyusunan tahapan layanan data mana yang akan direalisasikan menjadi service terlebih dahulu. Beberapa komponen yang perlu untuk di sediakan dulu termasuk diantaranya adalah perangkat infrastruktur, environment platform dan software pendukung.

1. Penyediaan Sarana (infrastruktur)
2. Penyediaan Software Pendukung (platform & tooling)
3. Pengembangan Layanan (pembuatan API, integrasi, uji coba)

Panduan Lengkap Membangun API.

1. Perencanaan dan Strategi
   API harus memberikan nilai tambah bagi pengguna yang dituju dan SKPD. Jadi, mulailah dengan tujuan dan pengguna yang dituju. API publik dapat digunakan oleh siapa pun yang memiliki kunci API.
2. Design API
   Sebelum menulis baris kode pertama, kita harus merancang arsitektur yang sesuai dengan kebutuhan SKPD. Arsitektur tersebut juga harus mencerminkan kebutuhan pengembang yang akan menggunakan API tersebut. API Gateway berfungsi sebagai titik koneksi tunggal antara semua klien. Kami lebih menyukai pendekatan ini karena konsistensinya, dapat digunakan kembali, dan desainnya yang tahan terhadap perubahan masa depan. Pendekatan ini juga meningkatkan pengalaman pengembang di seluruh perusahaan.
   

   API harus memenuhi lima persyaratan non-fungsional:

   • Kegunaan : pengembang harus dapat mempelajari dan menggunakan API dengan upaya minimum.
   • Keandalan : API harus memiliki waktu henti yang minimal.
   • Skalabilitas : sistem harus menangani lonjakan beban.
   • Testabilitas : penguji harus dapat dengan mudah mengidentifikasi cacat apa pun.
   • Keamanan : API harus dilindungi dari pengguna jahat.
3. Pengembangan API
   Setelah menyelesaikan desain API, saatnya membangun API SKPD sendiri. Proses ini bersifat iteratif. Kami ingin membuat satu titik akhir berorientasi fitur pada satu waktu dengan fungsionalitas dasar. Kemudian, secara bertahap tambahkan lebih banyak kolom atau parameter, uji, dan tulis dokumentasi detail.
   • Tentukan semua respon API
   • Menangani pengecualian dan kesalahan
   • Banung titik akhir API
   • Analisis Kinerja API
   • Terapkan caching sisi klien
   • Buat Dokumen API
   • Tambahkan versi untuk API publik
4. Pengujian API
   Dengan virtualisasi API, dapat mulai melakukan mengujian API sebelum selesai. Selain pengujian Unit dan Integrasi, kita dapat melakukan pengujian Fungsional, Keandalan, Beban, Keamanan, dan pengujian lainnya. Berikut adalah beberapa aturan umum untuk pengujian API
   • Uji fungsi API secara terpisah.
   • Gunakan data realistis untuk hasil realistis.
   • Uji dalam berbagai kondisi jaringan yang mungkin ditemui pengguna dalam produksi.
   • Simulasikan kesalahan dan kasus-kasus ekstrem dengan mengubah respons secara cepat.
   • Jangan gunakan API langsung untuk pengujian kinerja.
5. Pemantauan dan Peningkatan API
   API perusahaan dihosting di gateway API yang menjamin keamanan, performa, dan skalabilitas tinggi. Namun, gateway saja mungkin tidak cukup.

Lampiran & Panduan

Dokumen ini juga memuat panduan pengembangan API, perencanaan, desain API, pengujian, pemantauan, dan best practice agar API dapat digunakan oleh pengembang internal dan eksternal secara aman dan efisien.

Panduan Singkat Membangun API

1. Perencanaan: tentukan tujuan dan pengguna API.
2. Design API: tentukan arsitektur, gunakan API Gateway untuk konsistensi.
3. Pengembangan: bangun endpoint berorientasi fitur secara iteratif.
4. Testing: unit, integrasi, fungsional, performa, keamanan.
5. Monitoring: logging dan analytics penggunaan API.

Tahapan Teknis Implementasi E-Gift

Panduan Membuat API dalam Framework Laravel

Bagian ini memberikan panduan singkat dalam membangun API menggunakan framework Laravel. Tujuannya agar pengembang di lingkungan Pemerintah Kabupaten Tasikmalaya memiliki pedoman yang seragam dalam pembuatan layanan API yang terstandarisasi sesuai dengan pedoman E-GIFT.

I. Install Laravel

• Instal Laravel versi terbaru menggunakan Composer:
  composer create-project laravel/laravel nama_proyek
• Pastikan konfigurasi server PHP, database, dan web server sesuai (misal Nginx atau Apache).
• Jalankan server pengembangan dengan perintah:
  php artisan serve

II. Menyiapkan Database dan Model

• Konfigurasikan koneksi database di file .env.
• Buat migration menggunakan perintah:
  php artisan make:migration create_nama_tabel_table
• Buat model dengan perintah:
  php artisan make:model NamaModel
  untuk menghubungkan tabel database ke logika aplikasi.

III. Buat Rute API (CRUD)

• Buka file routes/api.php.
• Tambahkan endpoint API untuk operasi CRUD (Create, Read, Update, Delete) seperti contoh di bawah:

                        
        // routes/api.php
        use App\Http\Controllers\Api\DataController;

        Route::get('/data', [DataController::class, 'index']);      // Read - menampilkan semua data
        Route::post('/data', [DataController::class, 'store']);     // Create - menambahkan data baru
        Route::get('/data/{id}', [DataController::class, 'show']);  // Read - menampilkan detail data
        Route::put('/data/{id}', [DataController::class, 'update']); // Update - memperbarui data
        Route::delete('/data/{id}', [DataController::class, 'destroy']); // Delete - menghapus data

Gunakan middleware seperti auth:sanctum jika membutuhkan autentikasi. Setiap rute di atas akan dihubungkan dengan metode yang sesuai di dalam DataController.

IV. Buat Pengontrol dan Metode (CRUD)

• Buat controller menggunakan perintah:
  php artisan make:controller Api/DataController --resource
• Controller ini akan berisi metode untuk menangani permintaan CRUD (Create, Read, Update, Delete) sesuai dengan rute API yang telah dibuat.
• Pastikan setiap respons dikembalikan dalam format JSON yang konsisten, sehingga mudah digunakan oleh aplikasi lain atau frontend.

// app/Http/Controllers/Api/DataController.php
        namespace App\Http\Controllers\Api;

        use App\Http\Controllers\Controller;
        use Illuminate\Http\Request;
        use App\Models\Data;

        class DataController extends Controller
        {
            // READ - Menampilkan semua data
            public function index()
            {
                $data = Data::all();
                return response()->json([
                    'success' => true,
                    'message' => 'Daftar data berhasil diambil',
                    'data' => $data
                ], 200);
            }

            // CREATE - Menyimpan data baru
            public function store(Request $request)
            {
                $validated = $request->validate([
                    'nama' => 'required|string|max:255',
                    'deskripsi' => 'nullable|string',
                ]);

                $data = Data::create($validated);

                return response()->json([
                    'success' => true,
                    'message' => 'Data berhasil ditambahkan',
                    'data' => $data
                ], 201);
            }

            // READ ONE - Menampilkan detail data berdasarkan ID
            public function show($id)
            {
                $data = Data::find($id);

                if (!$data) {
                    return response()->json([
                        'success' => false,
                        'message' => 'Data tidak ditemukan',
                    ], 404);
                }

                return response()->json([
                    'success' => true,
                    'message' => 'Detail data ditemukan',
                    'data' => $data
                ], 200);
            }

            // UPDATE - Memperbarui data berdasarkan ID
            public function update(Request $request, $id)
            {
                $data = Data::find($id);

                if (!$data) {
                    return response()->json([
                        'success' => false,
                        'message' => 'Data tidak ditemukan',
                    ], 404);
                }

                $validated = $request->validate([
                    'nama' => 'required|string|max:255',
                    'deskripsi' => 'nullable|string',
                ]);

                $data->update($validated);

                return response()->json([
                    'success' => true,
                    'message' => 'Data berhasil diperbarui',
                    'data' => $data
                ], 200);
            }

            // DELETE - Menghapus data berdasarkan ID
            public function destroy($id)
            {
                $data = Data::find($id);

                if (!$data) {
                    return response()->json([
                        'success' => false,
                        'message' => 'Data tidak ditemukan',
                    ], 404);
                }

                $data->delete();

                return response()->json([
                    'success' => true,
                    'message' => 'Data berhasil dihapus'
                ], 200);
            }
        }
        

Setiap metode mengembalikan response JSON yang berisi kunci success, message, dan data. Pola ini memudahkan integrasi antar aplikasi serta mematuhi prinsip interoperabilitas E-GIFT.

V. Tambahkan Autentikasi ke API

• Gunakan Laravel Sanctum atau Laravel Passport untuk otentikasi API.
• Pastikan token API dikelola dengan aman dan terenkripsi.
• Setiap permintaan ke endpoint sensitif harus melalui middleware('auth:sanctum').
• Simpan log aktivitas API untuk kebutuhan audit dan keamanan sistem.

Panduan Menguji API di Laravel

Setelah API dikembangkan, tahap berikutnya adalah melakukan pengujian menggunakan alat bantu seperti Postman untuk memastikan setiap endpoint berfungsi sesuai dengan standar interoperabilitas E-GIFT. Pengujian ini juga memastikan bahwa autentikasi, format respons, dan status kode yang dihasilkan sudah sesuai.

I. Install Postman

• Unduh dan pasang aplikasi Postman dari situs resmi https://www.postman.com/downloads/.
• Pastikan API Laravel dapat diakses melalui alamat lokal (misalnya http://127.0.0.1:8000/api/data) atau dari server jika sudah dideploy.

II. Buat Koleksi (Collection)

• Buka aplikasi Postman dan klik New > Collection untuk membuat koleksi baru.
• Beri nama koleksi sesuai proyek, misalnya: “E-GIFT API Kabupaten Tasikmalaya”.
• Tambahkan variabel global seperti base_url agar mudah mengganti lingkungan (local, staging, production) tanpa ubah URL satu per satu.

III. Buat Permintaan (Request)

• Klik Add Request di dalam koleksi untuk menambahkan endpoint baru.
• Pilih metode sesuai kebutuhan:
  • GET – untuk mengambil data.
  • POST – untuk menambah data baru.
  • PUT – untuk memperbarui data.
  • DELETE – untuk menghapus data.
• Masukkan URL endpoint API Laravel kamu, misalnya: base_url/api/data
• Jika endpoint membutuhkan autentikasi, tambahkan header: Authorization: Bearer <token>
• Untuk metode POST atau PUT, buka tab Body, pilih raw dan format JSON, lalu masukkan contoh data:

{
  "nama": "Contoh Data",
  "deskripsi": "Data percobaan untuk uji API E-GIFT"
}

• Klik tombol Send untuk melihat hasil respon API.
• Pastikan status kode yang muncul sesuai ekspektasi:
  • 200 → Permintaan berhasil.
  • 201 → Data berhasil ditambahkan.
  • 400/422 → Validasi gagal.
  • 401 → Autentikasi gagal (token salah atau tidak dikirim).
  • 500 → Terjadi kesalahan pada server.