PHP Classes

File: documentation/apis/id/getting_started.md

Recommend this page to a friend!
  Classes of Aby Dahana   Aksara   documentation/apis/id/getting_started.md   Download  
File: documentation/apis/id/getting_started.md
Role: Auxiliary data
Content type: text/markdown
Description: Auxiliary data
Class: Aksara
A CodeIgniter based API and CRUD generator
Author: By
Last change: Update of documentation/apis/id/getting_started.md
Date: 2 years ago
Size: 3,120 bytes
 

Contents

Class file image Download

Pengenalan Aksara API

Hampir sebagian aplikasi yang dikembangan saat ini memerlukan API sebagai metode bertukar dan integrasi data antar platform yang berbeda. Selain lebih optimal, pemanfaatan API memungkinkan jangkauan pengelolaan data yang lebih luas. Akan tetapi kemudahan yang ditawarkan tentu saja membutuhkan waktu ekstra untuk mengimplementasikan alurnya. Baik pada framework populer atau yang khusus dipergunakan untuk pengelolaan API, menawarkan berbagai jenis fitur serta keamanan yang handal. Namun fitur-fitur tersebut tidak secara langsung dapat dioperasikan dan perlu ruang lingkup yang dikhususkan untuk pengelolaan API.

Aksara memberikan seluruh fitur-fitur yang ditawarkan framework pengelola API baik kehandalan, keamanan dan ditambah lagi dengan kemudahan. Pengembang yang menggunakan Aksara sebagai framework tidak perlu lagi menciptakan algoritma atau alur khusus untuk menjalankan pengelolaan API. Pengembang hanya cukup bekerja dalam 1 controller, dan hal tersebut telah mewakili seluruh proses yang menjangkau baik akses melalui browser atau REST API. Bahkan pengembang tidak perlu lagi menyiapkan routing dan validasi, semua telah dibuat otomatis oleh Aksara.

Bagaimana Aksara API Bekerja?

Seketika pengembang menciptakan sebuah controller, maka secara otomatis modul yang dibuat tersebut dapat diakses melalui permintaan API yang mewakili seluruh fitur CRUD (Create, Read, Update dan Delete). Begitu juga apabila dalam controller tersebut diberikan validasi, maka filter API akan secara otomatis mengikuti validasi yang dibuat. Routing untuk URL API menggunakan URL yang sama pada saat mengakses aplikasi melalui browser. Pengembang hanya perlu menyiapkan kunci API yang diizinkan, yang nantinya akan digunakan oleh perangkat dalam melakukan transmisi melalui API.

Bagaimana Tingkat Keamanannya?

Untuk modul tertentu yang memerlukan hak akses secara khusus, pengembang hanya perlu membuat grup akses. Pembuatan grup akses ini sama halnya dengan pembuatan grup akses pengguna, yang didalamnya dapat diatur modul-modul mana saja yang diizinkan untuk diakses oleh grup tersebut. Kemudian perangkat yang melakukan transmisi melalui API akan diminta untuk melakukan otentikasi sesuai dengan nama pengguna dan kata sandi yang didaftarkan. Proses otentikasi ini disebut juga dengan "Handshake". Seketika perangkat melakukan Handshake, maka akan mendapatkan token sebagai identitas sementara perangkat, yang wajib dikirim kembali dalam proses transmisi agar permintaan dianggap sah. Apabila token tidak sesuai dengan informasi yang didapatkan dari proses Handshake, maka permintaan akan secara otomatis tertolak dan perangkat tidak dapat melakukan akses API pada modul yang membutuhkan otentikasi.

Bagaimana Validasi Proses CRUD Bekerja?

Transmisi API akan menggunakan controller yang sama di mana pengembang memberikan validasi untuk tiap-tiap bidang input, termasuk jenis-jenisnya. Proses transmisi tidak dapat dilakukan apabila data yang dikirimkan tidak cocok dengan validasi yang diizinkan dan akan mengembalikan pesan-pesan kesalahan terkait dengan bidang yang diisikan.