Menggunakan dan menghubungkan ke API platform beseller. API: apa itu, cara kerja, dan menyiapkan tipe API integrasi

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 lengkap;
    • Kontak Alamat Surel;
    • Nomor kontak telepon;
    • Alamat pengiriman yang ditentukan: kode pos, nama hunian, nama jalan, nomor rumah, nomor bangunan, nomor rumah susun, lantai;

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

rencana pengembangan API

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

  1. Bagian katalog.
  2. Barang-barang.
  3. Sebuah keranjang.
  4. Dengan diskon.
  5. Metode pengiriman.
  6. Cara 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 memudahkan 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 browser Google Chrome yang memungkinkan Anda membuat 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

{
"Saring": (
"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"
}
]
}

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. Apa yang terjadi jika 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, memanggil operasi seperti “hapus file jendela", "tulis Halo, dunia dalam font yang dipilih!", selama operasi ini perpustakaan primitif grafis akan menghubungi perpustakaan antarmuka jendela dengan permintaan yang sesuai, dan perpustakaan ini akan menghubungi API sistem operasi dengan permintaan seperti "memasukkannya ke dalam kartu video saya menyangga ini".

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. Browser yang berbeda, secara umum, menggunakan pustaka HTML yang berbeda, dan, lebih jauh lagi, semua ini dapat (secara umum) dikompilasi menggunakan pustaka primitif yang berbeda dan pada sumber yang berbeda. sistem operasi Oh.

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

  • Kesulitan dalam porting kode program dari satu sistem API ke sistem API lainnya (misalnya, saat mengubah 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 lebih rendah.

Tipe API dasar

  • Akses API terbatas hanya untuk pengembang internal
  • Aplikasi ditujukan untuk karyawan perusahaan

Penggerak Bisnis:

  • Konsistensi pembangunan
  • Pengurangan biaya
  • Peningkatan efisiensi pembangunan

API Mitra

  • API hanya tersedia kumpulan terbatas mitra bisnis
  • Aplikasi dirancang untuk konsumen akhir dan pengguna bisnis

Penggerak Bisnis:

  • Otomatisasi proses pengembangan
  • Pengembangan kemitraan
  • Mengoptimalkan proses interaksi dengan mitra

API Publik

Akses diberikan kepada pengembang eksternal mana pun. Aplikasi ditujukan untuk pengguna akhir

Penggerak Bisnis:

  • Pengembangan layanan baru
  • Pembangunan ekosistem
  • Interaksi multisaluran

API paling terkenal

API sistem operasi

API GUI

  • Direct3D (bagian dari DirectX)
  • DirectDraw (bagian dari DirectX)

API Audio

  • DirectSound (bagian dari DirectX)
  • DirectMusic (bagian dari DirectX)

API sistem otentikasi

Prinsip dan penggunaan API Ekonomi

  • Pekerjaan API harus memiliki nilai yang terukur. Jangan buang sumber daya untuk membuat API yang tidak akan digunakan oleh pengembang mana pun.
  • Hanya buat API jika API tersebut memiliki pengguna tertentu. Pasti ada partner atau ekosistem yang membutuhkannya.
  • Rata-rata perusahaan selalu menggunakan lebih banyak API daripada yang mereka buat sendiri. Departemennya akan menangani banyak API, dan CIO akan ditugaskan untuk mengelolanya.
  • API sangat penting untuk Internet of Things, pengalaman konsumen, analitik, dan sistem Informasi. Jika Anda lupa tentang hal-hal ini saat membuat API, pikirkan baik-baik.

API memungkinkan organisasi menciptakan pengalaman pengguna yang dipersonalisasi

Harapan dan perilaku pelanggan berubah

Pembeli:

  • Memerlukan pendekatan individual – sesuai ketentuan mereka
  • Harapkan layanan terintegrasi yang komprehensif
  • Mereka akan beralih ke siapa saja yang lebih memenuhi kebutuhan mereka

Organisasi:

  • Berinteraksi dengan pelanggan melalui situs web interaktif yang dibuat untuk tujuan ini aplikasi seluler dan antarmuka digital ramah lainnya
  • Harapkan layanan terintegrasi yang komprehensif
  • Mereka akan beralih ke siapa saja yang lebih memenuhi kebutuhan mereka.

API ada dimana-mana!

Kronologi kejadian

2019

Penelitian oleh TAdviser bersama dengan PJSC VTB Bank dengan partisipasi Skolkovo: transformasi API dimulai di sektor perbankan Rusia

Bank Sentral mengundang sekitar 20 bank untuk berpartisipasi dalam uji coba di bidang API terbuka

Pada tanggal 21 Agustus 2019 diketahui bahwa Bank Rusia bertindak sebagai koordinator proyek percontohan di bidang API terbuka ( antarmuka perangkat lunak aplikasi) untuk integrasi layanan perbankan dalam Uni Ekonomi Eurasia (EAEU). Pada saat materi ini dipublikasikan, Bank Sentral, bersama dengan bank sentral negara-negara EAEU, sedang mempersiapkan proyek percontohan untuk implementasi. Para bankir yang menerima proposal Bank Sentral memberi tahu Kommersant tentang hal ini. Secara total, sekitar 20 lembaga kredit telah menerima surat dari regulator yang harus memberikan tanggapan tentang kesiapan mereka untuk berpartisipasi pada tanggal 23 Agustus. Baca selengkapnya.

Industri sekuritas siap menerima API

Pada tanggal 2 Agustus 2019 diketahui bahwa studi bersama oleh SWIFT dan BCG mengungkapkan peningkatan penggunaan API dilatarbelakangi oleh keinginan perusahaan untuk meningkatkan efisiensi dan menawarkan layanan.

Area layanan pasar kertas berharga mendekati titik balik dalam penerapan antarmuka pemrograman aplikasi (API) seiring upaya perusahaan untuk meningkatkan efisiensi dan menerapkan model bisnis modern.

Menurut survei BCG, kesadaran API di kalangan manajer aset meningkat sebesar 26% (dari 46% menjadi 72%) selama tahun 2018 saja. Meningkatnya minat komersial mendorong skema percontohan dan kasus penggunaan, khususnya antara perusahaan manajemen aset dan kustodiannya.

API mempunyai potensi untuk membantu industri sekuritas mengatasi jenis aset yang beragam dan beragam, pertukaran informasi yang kompleks, dan tekanan biaya yang terus meningkat. Laporan tersebut mengidentifikasi empat bidang di mana API dapat memberikan manfaat bagi seluruh industri:

  • Efisiensi dan penghematan biaya melalui pertukaran data otomatis
  • Akses ke informasi real-time seperti status penyelesaian dan risiko intraday
  • Layanan tambahan: data dan analitik yang diperkaya
  • Metrik operasional memungkinkan penyedia layanan membandingkan kinerja antar pelaku pasar

Adopsi API lebih lambat di industri sekuritas dibandingkan industri jasa keuangan lainnya karena kurangnya kerangka peraturan dan kurangnya konsistensi dalam kemauan pelaku pasar untuk mengadopsi API. Perusahaan manajemen aset sangat bervariasi dalam kecanggihan teknis dan keterbukaan mereka dalam berinteraksi dengan penyedia melalui API. Sekitar 56% responden survei BCG menganggap tingkat adopsi API pasca-perdagangan sebagai “eksperimental,” sementara hanya 21% yang mengatakan tingkat adopsi tersebut “tinggi” atau “sedang.”

API dapat menjadi pendorong inovasi yang kuat dalam pasca-perdagangan, seperti yang terjadi pada industri pembayaran dan bidang perbankan lainnya. Minat terhadap teknologi ini semakin meningkat, dan hasil percobaan pertama tampak menjanjikan. Namun untuk benar-benar mendorong dan mempercepat adopsi API secara luas, kita perlu menghilangkan ketidakpastian seputar standar dan meningkatkan pemahaman tentang kematangan teknologi.

kata Juliet Kennel, kepala departemen sekuritas dan pasar valuta asing di SWIFT


Laporan ini memberikan empat alasan mengapa industri harus menerapkan API:

  • Interaksi dalam infrastruktur umum. Elemen dasar solusi API seperti identitas, autentikasi, keamanan, dan tata kelola koneksi jaringan, harus disepakati di tingkat industri dan bukan di antara masing-masing perusahaan.
  • Koordinasikan standar API untuk menjaga interoperabilitas. Perkembangan berbagai standar dapat mengurangi efektivitas penggunaan API. Industri ini membutuhkan standar API tunggal yang dapat diterapkan di semua penyedia.
  • Dukungan untuk API jaringan, bukan solusi p2p. Perusahaan bisa mendapatkan keuntungan dari API jaringan: misalnya, satu panggilan untuk memeriksa status penyelesaian dari broker-dealer dapat dikirim ke beberapa kustodian secara bersamaan. Solusi jaringan akan mendukung konvergensi untuk penjelasan data dan karakteristik API lainnya.
  • Memenuhi standar keamanan dan keberlanjutan yang ketat. Agar pengembangan berhasil, solusi API apa pun harus memilikinya level tinggi perlindungan dan keberlanjutan data.
API telah menjadi salah satu teknologi utama dalam transformasi digital di seluruh sektor perbankan. API kini mulai memasuki industri sekuritas dan menjadi teknologi terdepan di kalangan perusahaan yang ingin beralih ke layanan digital. Meskipun terdapat kesulitan dalam penerapan API dalam hal interoperabilitas dan keamanan, kami yakin bahwa kesulitan tersebut dapat diatasi dan kami berharap penerapan teknologi ini lebih lanjut dalam waktu dekat.

kata Sumitra Karthikeyan, kepala layanan sekuritas di BCG


Pengenalan API di pasar sekuritas berdasarkan SWIFT dapat memastikan pencapaian tujuan utama seperti mengurangi biaya dan menciptakan peluang bisnis tambahan bagi pelaku pasar dan, khususnya, bagi perusahaan manajemen dan investor akhir. Oleh karena itu, NSD sedang mempelajari penggunaan API terbuka dan secara aktif bekerja sama dengan SWIFT dalam hal standardisasi teknologi API dan penggunaan praktis teknologi ini dalam pasca-perdagangan global, platform perbankan terbuka Tink mengklaim bahwa Lihat juga

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.

Minus:

  • 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 eksternal data. 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/

Di mana alih-alih bot0000000, pengidentifikasi unik bot Anda ditempatkan, 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 maksimum Informasi 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 halnya dengan 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 interaktif dengan jaringan sosial dan messenger, gunakan kemampuan pihak ketiga sistem komputasi 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 untuk akses terbuka. Jika Anda memiliki portal dan ingin membuat aplikasi seluler untuknya di Android/IOS, tulis ulang sistem di bawah satu API - Keputusan terbaik. Seluruh struktur data disistematisasikan. Situs dan aplikasi akan beroperasi melalui saluran data tunggal.

Mari kita mulai dengan dasar-dasarnya: apa itu API? Singkatannya adalah singkatan dari Application Programming Interface, atau antarmuka untuk pemrograman aplikasi. Namanya sepertinya berbicara sendiri, tetapi lebih baik mempertimbangkan penjelasan yang lebih detail.

Seperti yang telah disebutkan, API, pertama-tama, adalah sebuah antarmuka. Antarmuka yang memungkinkan pengembang menggunakan blok siap pakai untuk membangun aplikasi. Dalam hal pengembangan aplikasi seluler, perpustakaan untuk bekerja dengan rumah pintar dapat bertindak sebagai API - semua nuansa diterapkan di perpustakaan dan Anda hanya mengakses API ini dalam kode Anda.

Dalam kasus aplikasi web, API dapat mengembalikan data dalam format selain HTML standar, sehingga nyaman digunakan saat menulis aplikasi Anda sendiri. API publik pihak ketiga paling sering menyajikan data dalam salah satu dari dua format: XML atau JSON. Jika Anda memutuskan untuk membuat API untuk aplikasi Anda, ingatlah bahwa JSON jauh lebih ringkas dan mudah dibaca daripada XML, dan layanan yang menyediakan akses ke data dalam format XML secara bertahap meninggalkan XML.

API dalam aplikasi web beserta contohnya

Sebuah aplikasi - misalnya, Github - memiliki API sendiri yang dapat digunakan oleh pengembang lain. Cara mereka menggunakannya bergantung pada kemampuan yang disediakan API dan seberapa baik imajinasi pengembang bekerja. GitHub API memungkinkan, misalnya, memperoleh informasi tentang pengguna, avatarnya, pembaca, repositori, dan banyak informasi berguna dan menarik lainnya.

Dengan cara serupa, Anda dapat mengirim permintaan dalam bahasa apa pun, termasuk Ruby. Tanggapan terhadap permintaan tersebut kira-kira berupa informasi berikut:

( "login" : "Freika" , "id" : 3738638, "avatar_url" : "https://avatars.githubusercontent.com/u/3738638?v=3", "gravatar_id" : "" , "url" : "https://api.github.com/users/Freika", "html_url" : "https://github.com/Freika" , "followers_url" : "https://api.github.com/users/Freika/followers", "url_berikut" : "https://api.github.com/users/Freika/following(/other_user)", "inti_url" : "https://api.github.com/users/Freika/Gists(/Gist_id)", "url_berbintang" : "https://api.github.com/users/Freika/starred(/owner)(/repo)", "langganan_url" : "https://api.github.com/users/Freika/subscriptions", "url_organisasi" : "https://api.github.com/users/Freika/orgs", "repos_url" : "https://api.github.com/users/Freika/repos", "url_acara" : "https://api.github.com/users/Freika/events(/privacy)", "menerima_acara_url" : "https://api.github.com/users/Freika/received_events", "type" : "Pengguna" , "site_admin" : false , "nama" : "Evgeniy" , "perusahaan" : "" , "blog" : "http://frey.su/" , "lokasi" : " Barnaul" , "email" : "" , "dapat disewa" : true , "bio" : null, "public_repos" : 39, "public_gists" : 13, "followers" : 15, "following" : 21, "created_at" : "2013-03-01T13:48:52Z" , "updated_at" : "2014-12-15T13:55:03Z" )

Seperti terlihat dari blok di atas, respon berisi login, avatar, link ke profil di situs dan di API, status pengguna, jumlah repositori publik dan informasi berguna dan menarik lainnya.

API saja tidak cukup

Membuat API lengkap untuk aplikasi Anda hanyalah setengah dari perjuangan. Bagaimana Anda bisa mengakses API? Bagaimana pengguna Anda mengaksesnya?

Hal pertama yang terlintas dalam pikiran adalah rangkaian permintaan HTTP yang biasa untuk diterima informasi yang perlu, dan ini adalah jawaban yang salah. Metode yang paling jelas dalam hal ini bukanlah yang paling mudah dan sederhana. Akan jauh lebih masuk akal untuk membuat perpustakaan khusus untuk bekerja dengan antarmuka, yang akan menjelaskan semua cara yang diperlukan untuk menerima dan mengirim informasi menggunakan API.

Mari kita gunakan Github sekali lagi untuk memberikan contoh: untuk bekerja dengan API dari layanan luar biasa ini (dan antarmukanya menyediakan kemampuan yang luas), beberapa perpustakaan telah dibuat dalam berbagai bahasa, misalnya permata Octokit. Dalam dokumentasi untuk perpustakaan tersebut (dan permata yang diberikan sebagai contoh), setiap pengembang yang tertarik akan dapat menemukan semua cara yang diperlukan untuk menerima informasi dari Github dan mengirimkannya kembali melalui API layanan.

Jadi, jika Anda membuat API Anda sendiri, pertimbangkan untuk membuat perpustakaan untuk digunakan dalam bahasa yang paling umum. Dan bersiaplah bahwa pada tingkat permintaan tertentu untuk aplikasi Anda, orang lain mungkin membuat perpustakaannya sendiri untuk bekerja dengan API Anda. Ini baik-baik saja.

tautan yang bermanfaat

Pada artikel selanjutnya kita akan membahas tentang cara membuat API dengan benar, memastikan keamanannya, dan membatasi akses ke informasi tertentu.

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 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 mengerjakan tugasnya 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 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 membuat perangkat lunak kamera mereka sendiri dan menafsirkan masukannya perangkat keras kamera. Namun pengembang sistem operasi Apple telah melakukan semua kerja keras ini, sehingga pengembang cukup menggunakan API kamera untuk menyematkan kamera dan kemudian melanjutkan menulis aplikasi mereka. Dan ketika Apple meningkatkan API kamera, 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 dan fungsi perangkat keras perangkat lunak, yang aplikasinya mungkin tidak memiliki izin untuk menggunakannya. Inilah sebabnya mengapa API sering kali memainkan peran besar dalam keamanan.

Misalnya, jika Anda pernah mengunjungi sebuah 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 bertanya "di mana Anda?" dan browser akan bekerja keras mengakses GPS Anda atau lokasi terdekat Jaringan Wi-Fi 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 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 Windows, Mac, dan Linux, memiliki izin yang diberlakukan oleh API berkas sistem. 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 saja jika Anda pernah melihatnya keberatan Google Peta tertanam di website, website ini menggunakan Google Maps API untuk menyematkan peta ini. 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 aksesnya Google Peta di situs web pihak ketiga, memastikan bahwa mereka menggunakannya secara konsisten daripada mencoba menerapkan bingkai secara acak 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 Twitter di situs web.

Standar OAuth juga mendefinisikan sejumlah API yang memungkinkan Anda masuk ke situs melalui layanan lain, seperti menggunakan kredensial masuk Anda. postingan Facebook, Google atau Twitter untuk masuk ke situs web baru tanpa membuat situs baru akun pengguna hanya untuk situs ini. 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 melihatnya platform perangkat lunak atau suatu layanan telah menambahkan API baru untuk perangkat keras atau layanan yang berbeda, akan lebih mudah bagi pengembang untuk menggunakan fitur tersebut.



Memuat...
Atas