Apa itu api

Kami telah merilis buku baru, Pemasaran Konten Media Sosial: Cara Memahami Pikiran Pengikut Anda dan Membuat Mereka Jatuh Cinta dengan Merek Anda.

Berlangganan

API adalah antarmuka eksternal untuk memprogram aplikasi, mengakses situs menggunakan protokol tertentu untuk memperoleh informasi dan menyederhanakan pengembangan program yang terkait dengan layanan internal.

Apa yang dimaksud dengan API?

Analogi paling sederhana dalam menggunakan API adalah dengan menggunakan kalkulator untuk melakukan perhitungan yang rumit. Katakanlah Anda memiliki tugas, Anda dapat memahami esensinya, membuat persamaan dan grafik, tetapi Anda tidak tahu cara melakukan operasi aritmatika dengan angka. Ada kalkulator di sebelah Anda yang dapat melakukan operasi ini dengan mudah. Anda tidak tahu apa yang terjadi di dalam komputer, dan Anda tidak perlu mengetahuinya. Anda memberikan informasi dalam satu bentuk, dan menerimanya dalam bentuk lain, yang diperlukan untuk tujuan Anda.

API apa pun bekerja berdasarkan prinsip ini. Anda tidak peduli bagaimana program mendapatkan jawabannya, jalur apa yang diambil permintaan di dalamnya, bagaimana perhitungannya dilakukan. Anda hanya yakin akan satu hal - sebagai tanggapan, informasi standar akan diberikan tentang keberhasilan operasi atau kesalahannya.

Antarmuka API memungkinkan Anda untuk tidak membuang waktu, uang, dan tenaga untuk membeli “sepeda baru”. Anda mendapatkan port informasi yang berfungsi yang menerima dan mengirimkan sejumlah data yang diperlukan untuk keperluan pengembangan Anda.

Kelebihan:

  • Menghemat pengembangan antarmuka Anda sendiri.
  • Tidak perlu memahami nuansa masalahnya.
  • API dikembangkan oleh para profesional dan mempertimbangkan semua faktor proses internal yang mungkin tidak Anda sadari saat membuat solusi.
  • Memungkinkan Anda berkomunikasi dengan layanan yang ditutup melalui protokol lain.

Kontra:

  • Jika layanan target diperbarui, API tidak selalu langsung menerima fungsionalitas penuh.
  • Anda tidak dapat menemukan kesalahan dan tidak mengetahui cara kerja proses dalam kode orang lain.
  • API tidak selalu memberikan hasil yang paling optimal dalam hal waktu, karena API dirancang untuk menangani kasus umum, bukan kasus spesifik.

Contoh API

Integrasi API adalah proses menghubungkan aplikasi ke antarmuka data eksternal. Bekerja dengan API dimulai dengan mempelajari dokumentasi dan protokol yang digunakan, dan kemudian mengintegrasikan program Anda secara langsung ke antarmuka. Mari kita lihat layanan terpopuler yang memiliki API sendiri.

VKAPI

Antarmuka eksternal untuk interaksi jejaring sosial populer VKontakte dengan klien, serta dengan aplikasi browser dan server. Memungkinkan Anda mengelola pesan komunitas, sampul grup, halaman pengguna jika Anda memiliki kunci akses yang sesuai.

Semua permintaan dibuat ke alamat tersebut https://api.vk.com/method/

Setelah garis miring muncul nama metode API yang digunakan dan parameter GET dari permintaan dikirimkan. Responsnya juga datang melalui HTTPS dalam format JSON.

API BOT TELEGRAM

Salah satu API paling populer. Ini digunakan untuk mengontrol bot di messenger Telegram. Setelah membuat bot melalui @botfather dan mendapatkan kunci akses yang diperlukan, Anda dapat mulai berinteraksi dengan backend.

Permintaan dapat diajukan ke: https://api.telegram.org/bot0000000:token/

Dimana bot0000000 diganti dengan pengidentifikasi unik bot Anda, dan token mengungkapkan kunci rahasia.

Permintaan dikirim melalui koneksi HTTPS, nama metode ditandai dengan garis miring ke alamat utama. Responsnya datang dalam format JSON.

BUKA API PETA CUACA

Seringkali diperlukan untuk memperoleh informasi cuaca tanpa menggunakan widget pihak ketiga dan aplikasi berbayar. Layanan OpenWeatherMap hadir untuk menyelamatkan dengan API terbuka dan gratis. Setelah mendaftar dan menerima data identifikasi, Anda dapat mengirim permintaan cuaca dari skrip server di seluruh dunia. Menanggapi ID kota, sumber daya mengembalikan informasi paling rinci tentang cuaca saat ini dan memberikan perkiraan untuk waktu dekat.

Format: Transmisi HTTP melalui api.openweathermap.org/data/2.5/weather?id= menunjukkan nomor identifikasi kota yang diinginkan. Respons server: JSON.

API GOOGLE MAPS

Apa yang lebih bagus daripada peta dunia interaktif di situs web? Apalagi jika ini bukan sisipan template dari Google Maps, tetapi peta populer edisi pribadi Anda dengan kelompok penanda pribadi. Peta akan berinteraksi dengan skrip lain di situs, mengirimkan informasi tentang klik dan koordinat.

Google Maps JavaScript API menawarkan kemampuan serupa. Modul ini sepenuhnya skrip dan berfungsi di sisi browser, jadi kita tidak memerlukan permintaan HTTP dari PHP dan pembentukan header di sisi server, seperti yang terjadi di API lainnya.

Misalnya, menempatkan penanda pada peta akan terlihat seperti ini:

var mark = google.maps.Marker baru((
posisi: myPOS,
peta: peta,
judul:"Halo!"
});

Apa kebutuhan dan manfaat menggunakan API?

Ada cukup banyak fungsi yang berguna.

Aspek pertama

Anda dapat menjalin interaksi pengguna yang interaktif dengan jejaring sosial dan pesan instan, menggunakan kemampuan sistem komputasi pihak ketiga untuk menampilkan nilai tukar, cuaca, dan informasi penting lainnya.

Dengan menggunakan API, Anda dapat langsung menghubungkan sumber daya dan solusi perangkat lunak lain ke server, yang biasanya memerlukan waktu berminggu-minggu untuk pengembangan. API menyederhanakan kehidupan ketika implementasi unik tidak diperlukan, dan keandalan serta keamanan adalah prioritas.

Aspek kedua

Jika Anda adalah pemilik daya komputasi yang kompleks, layanan populer, atau penyimpanan data untuk akses publik atau semi-pribadi, maka langkah yang baik adalah meningkatkan API Anda sendiri. Apa yang akan diberikannya:

  • Arus klien yang besar.
  • Akses yang disederhanakan ke layanan Anda untuk mitra.
  • Kenyamanan analisis statistik penggunaan layanan.

Aspek ketiga

Hampir sama dengan yang kedua. Namun tanpa harus mengimplementasikan API akses terbuka. Jika Anda memiliki portal dan ingin membuat aplikasi seluler di Android/IOS, maka menulis ulang sistem dalam satu API adalah solusi terbaik. Seluruh struktur data disistematisasikan. Situs dan aplikasi akan beroperasi melalui saluran data tunggal.

, fungsi, struktur, atau konstanta) yang dengannya satu program komputer dapat berinteraksi dengan program lain. Biasanya disertakan dalam deskripsi beberapa protokol Internet (misalnya RFC), kerangka perangkat lunak (framework), atau standar panggilan fungsi sistem operasi. Seringkali diimplementasikan oleh perpustakaan perangkat lunak atau layanan sistem operasi terpisah. Digunakan oleh programmer saat menulis semua jenis aplikasi.

API sebagai sarana integrasi aplikasi

API mendefinisikan fungsionalitas yang disediakan oleh program (modul, perpustakaan), sedangkan API memungkinkan Anda untuk mengabstraksikan bagaimana sebenarnya fungsionalitas ini diimplementasikan.

Jika suatu program (modul, perpustakaan) dianggap sebagai kotak hitam, maka API adalah sekumpulan “pegangan” yang tersedia bagi pengguna kotak ini dan yang dapat diputar dan ditariknya.

Komponen perangkat lunak berinteraksi satu sama lain melalui API. Dalam hal ini, komponen biasanya membentuk hierarki - komponen tingkat tinggi menggunakan API dari komponen tingkat rendah, dan pada gilirannya, menggunakan API dari komponen tingkat yang lebih rendah.

Protokol transfer data melalui Internet dibangun berdasarkan prinsip ini. Tumpukan protokol standar (model jaringan OSI) berisi 7 lapisan (dari lapisan transfer bit fisik ke lapisan protokol aplikasi seperti protokol HTTP dan IMAP). Setiap lapisan menggunakan fungsionalitas lapisan transfer data sebelumnya (“lebih rendah”) dan, pada gilirannya, menyediakan fungsionalitas yang diperlukan ke tingkat berikutnya (“lebih tinggi”).

Penting untuk dicatat bahwa konsep protokol memiliki arti yang dekat dengan konsep API. Keduanya merupakan abstraksi fungsionalitas, hanya dalam kasus pertama kita berbicara tentang transfer data, dan yang kedua kita berbicara tentang interaksi aplikasi.

API perpustakaan fungsi dan kelas menyertakan deskripsi tanda tangan Dan semantik fungsi.

Tanda tangan fungsi

Terkadang mereka membedakannya tanda tangan panggilan Dan tanda tangan implementasi fungsi. Tanda tangan panggilan biasanya dikompilasi dari struktur sintaksis pemanggilan fungsi, dengan mempertimbangkan tanda tangan cakupan fungsi yang diberikan, nama fungsi, urutan tipe argumen aktual dalam panggilan, dan tipe dari pemanggilan fungsi tersebut. hasil. Tanda tangan implementasi biasanya mencakup beberapa elemen dari struktur sintaksis deklarasi fungsi: penentu cakupan fungsi, namanya, dan urutan tipe argumen formal.

Misalnya, dalam bahasa pemrograman C++, suatu fungsi sederhana diidentifikasi secara unik oleh kompiler berdasarkan namanya dan urutan tipe argumennya, yang merupakan tanda tangan fungsi dalam bahasa ini. Jika suatu fungsi adalah metode dari kelas tertentu, maka nama kelas juga akan dicantumkan dalam tanda tangannya.

Dalam industri perangkat lunak, API standar yang umum untuk fungsionalitas standar memainkan peran penting karena mereka memastikan bahwa semua program yang menggunakan API umum akan bekerja dengan baik, atau setidaknya dengan cara yang lazim. Dalam kasus API GUI, ini berarti bahwa program akan memiliki antarmuka pengguna yang serupa, sehingga memudahkan untuk mempelajari produk perangkat lunak baru.

Di sisi lain, perbedaan API pada sistem operasi yang berbeda membuat sangat sulit untuk mem-porting aplikasi antar platform. Ada berbagai metode untuk mengatasi kompleksitas ini - menulis API "perantara" (wxWidgets, GTK, dll. API GUI), menulis pustaka yang memetakan panggilan sistem dari satu OS ke panggilan sistem dari OS lain (runtime seperti Wine, cygwin, dan lain-lain .), pengenalan standar pengkodean dalam bahasa pemrograman (misalnya, perpustakaan standar bahasa C), penulisan bahasa interpretasi yang diimplementasikan pada platform berbeda (python, Perl, php, tcl, Java, dll.).

Perlu juga dicatat bahwa programmer sering kali memiliki beberapa API berbeda untuk mencapai hasil yang sama. Selain itu, setiap API biasanya diimplementasikan menggunakan komponen perangkat lunak API dengan tingkat abstraksi yang lebih rendah.

Misalnya: untuk melihat baris “Halo, dunia!” ", Anda hanya perlu membuat dokumen HTML dengan judul minimal dan isi sederhana yang berisi baris ini. Saat browser membuka dokumen ini, program browser akan meneruskan nama file (atau deskriptor file yang sudah terbuka) ke perpustakaan yang memproses dokumen HTML, yang, pada gilirannya, menggunakan API sistem operasi, akan membaca file ini dan memahami strukturnya. , lalu panggil secara berurutan melalui pustaka API operasi grafis primitif standar seperti "bersihkan jendela", "tulis" Halo, dunia! Saat melakukan operasi ini, pustaka grafis primitif akan menghubungi pustaka antarmuka jendela dengan permintaan yang sesuai, dan pustaka ini akan memanggil API sistem operasi untuk menulis data ke buffer kartu video.

Selain itu, di hampir setiap level sebenarnya terdapat beberapa kemungkinan API alternatif. Misalnya: kita dapat menulis dokumen sumber bukan dalam HTML, tetapi dalam LaTeX, dan kita dapat menggunakan browser apa pun untuk menampilkannya. Selain itu, browser yang berbeda menggunakan pustaka HTML yang berbeda, dan selain itu, semua ini dapat dikompilasi menggunakan pustaka primitif yang berbeda dan pada sistem operasi yang berbeda.

Oleh karena itu, tantangan utama sistem API multi-level yang ada saat ini adalah:

  • Kesulitan dalam mem-porting kode program dari satu sistem API ke sistem API lainnya (misalnya saat mengganti OS);
  • Hilangnya fungsionalitas saat berpindah dari level yang lebih rendah ke level yang lebih tinggi. Secara kasar, setiap “lapisan” API dibuat untuk memfasilitasi pelaksanaan beberapa rangkaian operasi standar. Namun pada saat yang sama, menjadi sangat sulit atau pada dasarnya tidak mungkin untuk melakukan beberapa operasi lain yang disediakan oleh API tingkat yang lebih rendah.

API paling terkenal

Sistem operasi

Apa seperti API?

API adalah kependekan dari Antarmuka Pemrograman Aplikasi. Secara umum, setiap program, sistem operasi, dll. memiliki API sendiri. Windows API terdiri dari sejumlah fungsi yang memungkinkan Anda menggunakan konstruksi sistem Windows. Semua fungsi Windows API ditulis dalam C++, tetapi program Anda dapat dengan mudah menggunakannya dari Visual Basic. Fungsi API harus dideklarasikan!

Deklarasikan nama Fungsi Lib "libname" [()]

Kata kunci Lib menentukan di perpustakaan mana Visual Basic dapat menemukan fungsi yang diperlukan. Ini mengacu pada perpustakaan tautan dinamis (*.dll). Namun tidak perlu menentukan ekstensi di nama alias. Alias ​​​​menentukan dengan nama apa program harus mencari fungsi tertentu di perpustakaan. Arglist adalah parameter yang diteruskan. Windows API memungkinkan dua hal: menjalankan tugas tertentu dan mengakses sumber daya sistem. Anda dapat melihat daftar berbagai fungsi API dan deklarasinya menggunakan program API Viewer standar.

Catatan: Jika fungsi API mengharapkan variabel dari Anda, Anda harus mendeklarasikannya dan mengisinya dengan spasi. Itu. variabel harus ditentukan pengguna. Ini adalah fitur bahasa C++, tempat Windows API ditulis.

Mari kita lihat beberapa contoh:

Katakanlah aplikasi Anda perlu menentukan direktori tempat sistem operasi Windows 95/98/NT diinstal. Cara termudah untuk melakukannya adalah dengan menggunakan fungsi GetWindowsDirectory API.

1. Dalam modul kita mendeklarasikan fungsi GetWindowsDirectory API:

Deklarasikan Fungsi GetWindowsDirectory Lib "kernel32" Alias ​​​​_

"GetWindowsDirectoryA" (ByVal lpBuffer Sebagai String, ByVal_

nUkuran Selama) Selama

2. Dalam modul kita mendeklarasikan sebuah variabel, misalnya WinDir, yang harus diberi nama direktori.

WinDir Publik Sebagai String

3. Masuk ke dalam subrutin:

Kami telah mendeklarasikan variabel yang perlu diteruskan ke API dan sekarang kami mengisinya dengan spasi.

Jumlah spasi harus kira-kira sama dengan jumlah karakter yang harus dimiliki variabel.

Dalam hal ini, 20 sudah cukup, karena... Windows biasanya diinstal di C:\Windows atau C:\Win95, dll. Itu. jumlah karakter kemungkinan besar tidak akan melebihi 20

WinDir = Spasi(20)

Debug.Cetak Kiri(WinDir, GetWindowsDirectory(WinDir, 20))

Karena API adalah sebuah fungsi, sehingga harus mengembalikan beberapa nilai. Dalam hal ini, fungsi GetWindowsDirectory mengembalikan panjang nilai yang dicari. Itu. jika, misalnya, nilai yang diinginkan adalah C:\WINDOWS, maka fungsi tersebut akan mengembalikan nilai 10.

“Variabelnya panjangnya 20. 10 karakter ini ditulis dulu, lalu ada 10 spasi. Kenapa kita perlu 10 karakter tambahan? Lagi pula, ini menggunakan memori yang tidak perlu...

Oleh karena itu, dengan instruksi Left kita mengekstrak dari variabel WinDir sebanyak karakter pertama yang umumnya dibutuhkan...

Contoh kedua:

Misalnya, program Anda harus menentukan media mana yang berupa CD-ROM atau remote, dll. Toolkit Visual Basica "asli" tidak mengizinkan Anda melakukan ini - Anda harus menggunakan fungsi API.

1. Dalam modul kita mendeklarasikan fungsi GetDriveType API:

Deklarasikan Fungsi GetDriveType Lib "kernel32" Alias ​​​​_

"GetDriveTypeA" (ByVal nDrive As String) Selama

Parameter nDrive berarti huruf alfabet Latin ditambah titik dua, mis. nama drive potensial, seperti C:

2. Masuk ke dalam subrutin:

Di sini loop For...Next "menyelipkan" ke dalam fungsi GetDriveType semua huruf alfabet Latin secara bergantian. Fungsi Chr mengubah nilai tabel ASCII (0 hingga 255) menjadi huruf. Jadi 65 adalah huruf A, dan 90 adalah Z

Redupkan myDrive Sebagai Integer

Untuk myDrive = 65 Sampai 90

Debug.Cetak Chr(myDrive) & ":" & " - " & GetDriveType(Chr(myDrive) & ":")

Inilah yang akan dikembalikan oleh fungsi GetDriveType kepada kita, misalnya untuk saya:

Semua huruf lainnya ditandai dengan angka 1. Ya, untuk memahami sebutan tersebut Anda perlu mengetahui tabel berikut:

Nama konstan: Nilai:

DRIVE_TIDAK DIKETAHUI 0
DRIVE_NO_ROOT_DIR 1
DRIVE_REMOVEABLE 2
DRIVE_FIXED 3
DRIVE_REMOTE 4
DRIVE_CDROM 5
DRIVE_RAMDISK 6

Subrutin Utama dalam modul ini seperti Form_Load pada formulir, yaitu. dianggap yang utama dan dimuat secara default.

Tujuan dari banyak fungsi API dapat dengan mudah ditebak dari namanya. Misalnya, GetWindowsDirectory (dapatkan direktori Windows) atau GetDriveType (dapatkan jenis media).

API(Bahasa inggris) Antarmuka Pemrograman Aplikasi) - ini adalah antarmuka pemrograman aplikasi. API aplikasi atau layanan tertentu menyediakan serangkaian prosedur, fungsi, dan variabel siap pakai yang dapat digunakan oleh pengembang pihak ketiga untuk membuat aplikasi dan skrip mereka sendiri untuk bekerja dengan layanan ini.

Saat bekerja melalui API, aplikasi mengirimkan permintaan ke layanan dan menerima respons yang berisi data yang diminta, terlepas dari bahasa pemrograman yang digunakan untuk membuatnya.

Pemilik toko online, yang menggunakan layanan pihak ketiga dan aplikasi mereka sendiri, memiliki kesempatan untuk mengakses melalui API:

Informasi tentang pesanan yang ditempatkan

Tindakan (metode) yang tersedia untuk memproses informasi pesanan:

  1. Memilih informasi pesanan berdasarkan ID
  2. Memilih informasi pesanan berdasarkan filter
  3. Jumlah pesanan berdasarkan filter
  4. Buat pesanan
  5. Menghapus pesanan
  6. Penghapusan pesanan secara massal
  7. Memilih semua status yang tersedia untuk pesanan
  8. Perbarui status pesanan
  9. Menambahkan komentar ke pesanan

Informasi pelanggan

  1. Menambahkan pelanggan
  2. Hapus pelanggan
  3. Penghapusan massal pelanggan
  4. Memilih data pelanggan berdasarkan filter
  5. Jumlah pelanggan berdasarkan filter

Informasi tentang pengguna terdaftar

Tindakan (metode) yang tersedia untuk memproses informasi tentang pelanggan:

  1. Memilih informasi tentang pengguna terdaftar berdasarkan ID
  2. Memilih informasi tentang semua pengguna terdaftar
  3. Memilih informasi tentang semua data yang ditentukan oleh pengguna saat pendaftaran:
    • Nama belakang, nama depan, patronimik;
    • Alamat email kontak;
    • Nomor telepon kontak;
    • Alamat pengiriman yang ditentukan: kode pos, nama daerah, nama jalan, nomor rumah, nomor gedung, nomor apartemen, lantai;

Memperhatikan! Saat mendaftar, pengguna mungkin tidak melengkapi semua kolom di atas.

rencana pengembangan API

Dalam waktu dekat, kami berencana untuk membuka antarmuka yang mendukung interaksi toko dengan aplikasi dan layanan pihak ketiga untuk bekerja dengan:

  1. Bagian katalog.
  2. Barang-barang.
  3. Sebuah keranjang.
  4. Diskon.
  5. Metode pengiriman.
  6. Metode pembayaran.

Untuk menguji interaksi dengan API platform beseller, toko uji beseller-api.shop.by telah dibuat.

Untuk mengakses toko tes, Anda harus memberikan login dan kata sandi. Anda dapat memperolehnya berdasarkan permintaan dari manajer pribadi Anda.

Sebelum menguji interaksi dengan API, kami menyarankan Anda:

  1. lakukan beberapa pemesanan sendiri;
  2. berlangganan buletin;
  3. lihat bagaimana informasi tentang pesanan yang dilakukan dan pelanggan ditampilkan di panel administrasi toko.

Panel kontrol toko tersedia di: beseller-api.shop.by/manager/. Login dan password saat masuk ke control panel mirip dengan login dan password untuk mengakses toko.

Bagaimana cara terhubung melalui API ke toko Anda?

Untuk menghubungkan aplikasi dengan toko Anda, Anda perlu menentukan URL akses API dalam bentuk:

http://alamat_situs_anda:8082/graphql?token=kunci_rahasia_pribadi_anda

Anda dapat memperoleh kunci rahasia berdasarkan permintaan dari manajer pribadi Anda.

Fungsi dan variabel GraphQL untuk bekerja dengan API platform beseller

Cara terhubung ke API menggunakan bahasa pemrograman PHP

Untuk kenyamanan bekerja dengan API platform beseller, Anda dapat menggunakan:

  1. Kelas yang kami kembangkan untuk PHP.
    1. Klien Graphql- menerima dan mengirimkan data ke server;
    2. GrafikQlHelper- berisi API kueri dan mutasi yang diimplementasikan;
  2. Contoh penggunaan class untuk melakukan pemilihan dan perubahan pada database toko online.

Menyiapkan lingkungan lokal Anda

Untuk mendemonstrasikan dengan jelas pengiriman permintaan ke API dan respons yang diterima, Anda dapat menggunakan lingkungan lokal.

GraphiQL Feen digunakan sebagai lingkungan lokal, ini adalah ekstensi untuk browser Google Chrome yang memungkinkan Anda menghasilkan permintaan ke API.

Setelah menginstal aplikasi, ikon aplikasi akan muncul di browser Anda dekat bilah alamat.

Buka aplikasi GraphiQL Feen dan buka tab “SERVERS”, pilih metode pengiriman POST, lalu tentukan url akses API.

Alamat berikut harus digunakan sebagai url pengujian:

Lingkungan lokal dikonfigurasi, Anda dapat menghasilkan permintaan ke API. Untuk melakukan ini, Anda perlu membuka tab “QUERIES”.

Membentuk permintaan ke beseller API menggunakan GraphiQL Feen dan respon yang diterima

Penjelasan untuk tangkapan layar:

  1. Kueri yang disimpan
  2. Bidang untuk memasukkan permintaan
  3. Bidang masukan variabel
  4. Tanggapan diterima
  5. Tombol mulai

Contoh permintaan untuk mendapatkan daftar pesanan yang ditempatkan untuk jangka waktu tertentu

kueri ($pertama:Int, $offset:Int, $filter: OrdersFilterType)(
pesanan(pertama:$pertama, offset:$offset, filter:$filter)(
komentar
status(
pengenal
keterangan
nama
}
tanggal_buat
tanggal_perbarui
jumlah (
akhiran
nilai
}
pembayaran (
nama
keterangan
biaya (
akhiran
nilai
}
}
pengiriman (
nama
keterangan
biaya (
akhiran
nilai
}
}
mata uang (
kode_bank
kursus
akhiran
}
data_pengguna(
nama
keterangan
nilai
}
}
}

Menentukan jangka waktu untuk mengambil data tentang pesanan yang dilakukan

{
"menyaring": (
"tanggal_setelah": "16-11-2017T00:00:01Z",
"date_before": "23-11-2017T00:00:01Z"
}
}

Contoh respon dari API

{{
"data": (
"pesanan": [
{
"komentar": "Culpa officiis vel ut.",
"tanggal_buat": "22-11-2017 16:23:28",
"mata uang": [
{
"kode_bank": "BYN",
"kursus": 10.000,
"akhiran": "gosok."
}
],
"pengiriman": (
"biaya": [
{
"akhiran": "gosok.",
"nilai": 0
}
],
"deskripsi": "Kurir",
"nama": "adat"
},
"pembayaran": (
"biaya": [
{
"akhiran": "gosok.",
"nilai": 0
}
],
"deskripsi": "Kartu plastik",
"nama": "adat"
},
"status": (
"deskripsi": "Baru",
"id": 1,
"nama": "baru"
},
"jumlah": [
{
"akhiran": "gosok.",
"nilai": 4450
}
],
"tanggal_perbarui": "22-11-2017 16:23:28",
"data_pengguna": [
{
"deskripsi": "Alamat email",
"nama": "email",
"nilai": " [dilindungi email]"
},
{
"deskripsi": "Telepon",
"nama": "telepon",
"nilai": "784.392.3949 x69329"
},
{
"deskripsi": "Alamat",
"nama": "pendaftaran",
"value": "607 Erik Station Suite 057\nReynaberg, WY 83542-0037"
},
{
"deskripsi": "Komentar",
"nama": "komentar",
"value": "Id nam illo optio."
},
{
"deskripsi": "Nama",
"nama": "fio",
"nilai": "Jordi Mann MD"
}
]
}

Anda mungkin pernah melihat istilah "API". Pembaruan sistem operasi, browser web, dan aplikasi sering kali mengumumkan API baru untuk pengembang. Tapi apa itu API?

Antarmuka Pemrograman Aplikasi

Istilah API adalah akronim dan merupakan singkatan dari Application Programming Interface.

API itu seperti menu di restoran. Menu tersebut berisi daftar hidangan yang bisa Anda pesan, serta deskripsi setiap hidangan. Saat Anda menentukan item menu mana yang Anda inginkan, dapur restoran akan bekerja dan menyediakan hidangan siap saji untuk Anda. Anda tidak tahu persis bagaimana restoran menyiapkan makanan ini, dan Anda tidak perlu melakukannya.

Demikian pula, API menyediakan banyak operasi yang dapat digunakan pengembang, serta deskripsi tentang apa yang mereka lakukan. Pengembang tidak perlu mengetahui bagaimana, misalnya sistem operasi dibuat dan kotak dialog Save As ditampilkan. Mereka hanya perlu mengetahui bahwa itu tersedia untuk digunakan dalam aplikasi.

Ini bukan metafora yang sempurna karena pengembang mungkin harus menyediakan data API mereka sendiri untuk mendapatkan hasil, jadi mungkin ini lebih seperti restoran mewah tempat Anda dapat menyediakan beberapa bahan sendiri untuk digunakan di dapur.

API memungkinkan pengembang menghemat waktu dengan memanfaatkan implementasi platform untuk menyelesaikan pekerjaan penting. Hal ini membantu mengurangi jumlah kode yang perlu dikembangkan dan juga membantu menciptakan konsistensi antar aplikasi pada platform yang sama. API dapat mengontrol akses ke sumber daya perangkat keras dan perangkat lunak.

API membuat hidup lebih mudah bagi pengembang

Katakanlah Anda ingin mengembangkan aplikasi iPhone. Sistem operasi iOS Apple menyediakan API dalam jumlah besar, sama seperti sistem operasi lainnya, untuk mempermudah Anda.

Misalnya, jika Anda ingin menyematkan browser web untuk menampilkan satu atau lebih halaman web, Anda tidak perlu memprogram browser web Anda sendiri dari awal hanya untuk aplikasi Anda. Anda
Anda dapat menggunakan API WKWebView untuk menyematkan browser web WebKit (Safari) ke dalam aplikasi Anda.

Jika Anda ingin mengambil foto atau video dari kamera iPhone, Anda tidak perlu menulis antarmuka kamera Anda sendiri. Anda dapat menggunakan API Kamera untuk menyematkan kamera iPhone ke dalam aplikasi Anda. Jika API tidak ada, pengembang aplikasi harus menulis perangkat lunak kamera mereka sendiri dan menafsirkan masukan perangkat keras kamera. Namun pengembang sistem operasi Apple telah melakukan semua kerja keras tersebut, sehingga pengembang cukup menggunakan API kamera untuk menyematkan kamera dan kemudian melanjutkan menulis aplikasi mereka. Dan ketika Apple meningkatkan API kameranya, semua aplikasi yang menggunakannya secara otomatis akan memanfaatkan peningkatan tersebut.

Ini berlaku untuk semua platform. Misalnya, apakah Anda ingin membuat kotak dialog di Windows? Ada API untuk ini. Ingin mendukung otentikasi sidik jari di Android? Ada API untuk ini, jadi Anda tidak perlu menguji setiap sensor sidik jari dari setiap produsen Android. Pengembang tidak perlu menciptakan kembali roda tersebut berulang kali.

API mengontrol akses ke sumber daya

API juga digunakan untuk mengontrol akses ke perangkat keras dan fitur perangkat lunak yang mungkin tidak boleh digunakan oleh aplikasi. Inilah sebabnya mengapa API sering kali memainkan peran besar dalam keamanan.

Misalnya, jika Anda pernah mengunjungi suatu situs web dan melihat pesan di browser Anda bahwa situs web tersebut menanyakan lokasi persis Anda, situs web tersebut mencoba menggunakan API geolokasi di browser web Anda. Browser web menyediakan API untuk memudahkan pengembang web mengakses lokasi Anda - mereka cukup menanyakan "di mana Anda?" dan browser akan bekerja keras mengakses GPS atau jaringan Wi-Fi terdekat untuk menemukan lokasi fisik Anda .

Namun, browser juga memaparkan informasi ini melalui API karena aksesnya dapat dikontrol. Saat situs web ingin mengakses lokasi persis Anda, satu-satunya cara mendapatkannya adalah melalui API lokasi. Dan, ketika sebuah situs web mencoba menggunakannya, Anda—pengguna—dapat mengizinkan atau menolak permintaan tersebut. Sumber daya perangkat keras seperti sensor GPS hanya dapat diakses melalui API, sehingga browser dapat mengontrol akses ke perangkat keras dan membatasi apa yang dapat dilakukan oleh aplikasi.

Prinsip yang sama digunakan untuk sistem operasi seluler modern seperti iOS dan Android, di mana aplikasi seluler memiliki izin yang dapat diterapkan dengan mengontrol akses ke API. Misalnya, jika pengembang mencoba mengakses kamera melalui API kamera, Anda dapat menolak permintaan izin dan aplikasi tidak akan memiliki akses ke kamera perangkat Anda.

Sistem file yang menggunakan izin, seperti yang ada di Windows, Mac, dan Linux, memiliki hak yang diberlakukan oleh API sistem file. Aplikasi biasa tidak memiliki akses langsung ke hard drive fisik mentah. Sebaliknya, aplikasi harus mengakses file melalui API.

API digunakan untuk komunikasi antar layanan

API juga digunakan untuk alasan lain. Misalnya, jika Anda pernah melihat objek Google Maps yang disematkan di situs web, situs web tersebut menggunakan Google Maps API untuk menyematkan peta tersebut. Google menyediakan API seperti ini untuk pengembang web, yang kemudian dapat menggunakan API tersebut untuk merakit objek kompleks langsung di situs web mereka. Jika tidak ada API seperti itu, pengembang mungkin harus membuat peta mereka sendiri dan menyediakan data peta mereka sendiri untuk meng-host peta interaktif kecil di situs web.

Dan karena ini adalah API, Google dapat mengontrol akses ke Google Maps di situs web pihak ketiga, memastikan bahwa mereka menggunakannya secara konsisten daripada mencoba menerapkan secara acak bingkai yang ditampilkan situs web Google Maps, misalnya.

Ini berlaku untuk banyak layanan online yang berbeda. Ada API untuk meminta terjemahan teks dari Google Terjemahan atau menampilkan komentar Facebook atau tweet dari Twitter di situs web.

Standar OAuth juga mendefinisikan sejumlah API yang memungkinkan Anda masuk ke situs melalui layanan lain, seperti menggunakan akun Facebook, Google, atau Twitter untuk masuk ke situs web baru tanpa membuat akun pengguna baru hanya untuk situs tersebut. API adalah kontrak standar yang menentukan cara pengembang berinteraksi dengan layanan dan jenis keluaran yang diharapkan diterima oleh pengembang.

Jika Anda telah membaca artikel ini, Anda akan memiliki gambaran lebih baik tentang apa itu API. Pada akhirnya, Anda tidak perlu mengetahui apa itu API kecuali Anda seorang pengembang. Namun, jika Anda melihat platform atau layanan perangkat lunak telah menambahkan API baru untuk perangkat keras atau layanan yang berbeda, akan lebih mudah bagi pengembang untuk menggunakan fitur tersebut.

ARTIKEL TERKAIT