Memanggil API SOAP menggunakan cURL (Dengan Gambar)

Frasa "SOAP cURLs" terdiri dari dua teknologi populer yang mungkin pernah Anda dengar sebelumnya. Sebelum membahas hal lain, artikel ini akan membahas teknologi-teknologi tersebut dan kemampuannya.

💡

Apidog, sebuah platform pengembangan API yang mengutamakan desain, menyediakan berbagai modifikasi dan spesifikasi untuk seluruh siklus hidup API.

Jika Anda membutuhkan platform API untuk membangun, melakukan mock, debug, atau mendokumentasikan API, Apidog adalah pilihan yang optimal. Anda hanya perlu mengklik tombol di bawah ini. 👇 👇 👇

Terminologi Dasar tentang SOAP dan cURLs

Istilah "SOAP" dan "cURL" masing-masing merujuk pada teknologi yang unik.

SOAP: SOAP (Simple Object Access Protocol) adalah protokol pesan yang terutama digunakan untuk bertukar informasi terstruktur antara dua aplikasi atau sistem.

SOAP memainkan peran penting dalam industri layanan web karena kemampuannya untuk memfasilitasi pertukaran data dan komunikasi antara komponen perangkat lunak yang berbeda.

SOAP adalah protokol yang sangat terstruktur yang menggunakan format XML, terutama digunakan untuk aplikasi perusahaan atau sistem lama. Dengan ini disebutkan, Anda mungkin telah mengamati protokol lain menjadi lebih populer, seperti gaya arsitektur REST yang banyak dibahas.

Layanan web SOAP juga biasanya hadir dalam bentuk file WSDL.
cURL: cURL adalah singkatan dari "Client for URL". cURL adalah perangkat lunak sumber terbuka gratis yang menyediakan dua fungsi utama, alat baris perintah curl dan pustaka libcurl.

Alat baris perintah curl memungkinkan transfer data dengan menggunakan berbagai protokol jaringan seperti HTTP, HTTPS, dan banyak jenis lainnya langsung dari terminal Anda. Ada banyak kegunaan curl. Beberapa di antaranya, Anda dapat mengunduh file, mengirim data, dan mengambil konten halaman web atau respons server.

Di sisi lain, pustaka libcurl bertindak sebagai fungsi inti untuk transfer data. libcrul dapat diintegrasikan ke dalam berbagai bahasa pemrograman populer, seperti C, C++, Python, dan PHP. Dengan libcrul, pengembang dapat memanfaatkan kinerja cURL dengan aplikasi untuk tugas-tugas seperti mengotomatiskan pengunduhan dan pengunggahan file, serta membangun alat atau aplikasi khusus untuk berinteraksi dengan layanan web.

Ketika istilah-istilah tersebut digabungkan, "SOAP cURLs" mengacu pada penggunaan fungsionalitas cURL untuk berinteraksi secara khusus dengan layanan web berbasis SOAP.

Rincian Cara Kerja SOAP cURLs

1. Definisikan pesan SOAP:

Pertama, pesan permintaan SOAP tertentu diperlukan. Ini melibatkan penentuan operasi yang ingin Anda panggil pada layanan web dan data yang ingin Anda kirim, semuanya dalam format XML.
Anda dapat menemukan berbagai alat dan sumber daya yang tersedia untuk membantu Anda menentukan pesan SOAP, seperti file WSDL (Web Services Description Language) yang disediakan oleh layanan web atau alat online untuk menghasilkan pesan SOAP.

2. Susun perintah cURL:

Selanjutnya, susun perintah cURL yang menentukan detail permintaan HTTP yang membawa pesan SOAP. Ini melibatkan penggunaan berbagai opsi cURL untuk menentukan:
URL: Alamat endpoint layanan web yang ingin Anda jangkau.
Metode: Metode HTTP biasanya diatur ke "POST" karena pesan SOAP biasanya dikirim menggunakan metode POST.
Header: Header khusus untuk komunikasi SOAP, seperti "Content-Type: text/xml; charset=utf-8" diperlukan untuk menunjukkan format pesan dan pengkodean karakter.
Data: Konten pesan SOAP yang sebenarnya akan dimasukkan dalam badan permintaan menggunakan opsi "-d" dengan string pesan atau file yang berisi pesan.

3. Mengirim permintaan dan menerima sebuah respons:

Setelah Anda memiliki perintah cURL yang lengkap, Anda dapat mengeksekusinya di terminal Anda. Ini akan mengirimkan permintaan HTTP yang dibuat yang berisi pesan SOAP ke layanan web.
Layanan web akan memproses permintaan dan mengembalikan respons, biasanya dalam format XML.

4. Pemrosesan lebih lanjut terhadap respons:

Anda dapat mengurai respons XML untuk mengekstrak informasi relevan yang dikembalikan oleh layanan web. Ini mungkin melibatkan penggunaan alat atau pustaka tergantung pada bahasa pemrograman yang digunakan.

Cara Memanggil SOAP API Menggunakan cURL

Langkah 1: Pertama, Anda perlu menyiapkan pesan SOAP Anda. Jika ini adalah pertama kalinya Anda membuat pesan SOAP, Anda dapat merujuk ke contoh kode di bawah ini - namun, Anda perlu memodifikasinya untuk memastikan pesan tersebut memenuhi kebutuhan Anda.

Contoh pesan SOAP:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ws="http://www.example.com/webservice">
   <soapenv:Header/>
   <soapenv:Body>
      <ws:getGreeting>
         <ws:name>John Doe</ws:name>
      </ws:getGreeting>
   </soapenv:Body>
</soapenv:Envelope>

Bisakah Anda menebak apa yang diminta pesan dari layanan web?

Langkah 2: Siapkan perintah cURL Anda di terminal Anda. Mirip dengan langkah di atas, Anda dapat melihat contoh kode.

Contoh perintah cURL:

curl -X POST \
-H "Content-Type: text/xml; charset=utf-8" \
-H "SOAPAction: http://www.example.com/webservice/getGreeting" \
-d @soap_request.xml "https://dummy.webservice.com/path/to/service"

Penjelasan perintah cURL:

-X POST: Menentukan metode permintaan HTTP sebagai POST.
-H "Content-Type: text/xml; charset=utf-8" mengatur header content-type dengan menunjukkan data XML dengan pengkodean UTF-8.
-H "SOAPAction: http://www.example.com/webservice/getGreeting" mengatur header SOAPAction dengan menentukan operasi yang ditargetkan.
-d @soap_request.xml membaca konten pesan SOAP dari file bernama "soap_request.xml".
"https://dummy.webservice.com/path/to/service" diganti dengan URL sebenarnya dari endpoint layanan web.

Aplikasi Nyata dari SOAP cURLs

1. Integrasi sistem lama: SOAP sering digunakan dalam aplikasi perusahaan yang lebih lama. Jika Anda perlu berinteraksi dengan sistem lama yang belum dimigrasikan ke protokol yang lebih baru, cURL dapat menyediakan cara untuk membuat dan mengirim permintaan SOAP secara manual untuk pertukaran data.

2. Pengujian dan debugging layanan web SOAP: Pengembang dapat menggunakan cURL untuk langsung mengirim permintaan SOAP tertentu dan menganalisis respons untuk memecahkan masalah dengan layanan web SOAP. Ini memungkinkan kontrol granular atas permintaan dan membantu mengisolasi potensi masalah.

3. Skrip dan otomatisasi khusus: cURL dapat diintegrasikan ke dalam skrip dan program untuk mengotomatiskan tugas yang melibatkan komunikasi SOAP. Ini bisa berguna untuk skenario seperti secara berkala mengambil data dari layanan SOAP atau memicu tindakan tertentu berdasarkan pesan SOAP yang diterima.

Apidog - Membuat Pengujian SOAP Lebih Mudah

Apidog adalah platform pengembangan API yang menyediakan berbagai fungsionalitas untuk mempersonalisasi API sesuai keinginan Anda. Apakah Anda berencana untuk membuat API baru dari awal atau mengimpor API pribadi yang telah Anda kerjakan selama beberapa waktu, Apidog mendukung kedua pilihan tersebut.

api design apidog test build — Fungsi Apidog yang dapat dinikmati pengguna

button

Apidog mendukung impor file WSDL sehingga Anda dapat melihat layanan web berbasis SOAP. Selain itu, Anda juga dapat menghasilkan perintah cURL menggunakan pembuatan kode bahasa klien Apidog, sehingga Anda tidak perlu menebak-nebak apakah Anda benar atau salah!

Mengimpor File WSDL untuk Melihat Layanan Web Berbasis SOAP di Apidog

import wsdl file apidog — Mengimpor File WSDL ke Apidog

Pertama, tekan tombol Settings yang terletak di sisi kiri toolbar vertikal. Kemudian, temukan Import Data di bawah bagian Data Management. Terakhir, pilih WSDL untuk mengimpor file WSDL ke Apidog.

Mengedit File WSDL di Apidog

edit wsdl file apidog — Mengedit File WSDL dengan Apidog

Jika file WSDL telah berhasil diimpor, Anda akan menemukan file WSDL Anda di sebelah kiri, seperti yang ditunjukkan pada gambar yang ditunjuk oleh Panah 1. Anda kemudian dapat mengklik panah bernomor untuk mulai mengedit.

Setelah Anda mengimpor dan men-debug file WSDL Anda, Anda dapat mulai mengujinya di Apidog untuk mencari lebih banyak kesalahan. Jika Anda masih tidak yakin apakah file WSDL Anda benar atau salah, lihat contoh file WSDL untuk detail lebih lanjut.

Mengimpor cURL ke Apidog

Apidog mendukung impor kode baris perintah cURL bagi mereka yang sudah menyiapkannya.

start curl import apidog — Memulai impor cURL di Apidog

Pada bagian APIs, temukan tombol + berwarna ungu yang terletak di sekitar sudut kiri atas jendela Apidog. Kemudian pilih Import cURL. Jika Anda tidak dapat menemukan tombol yang disebutkan, Anda dapat menggunakan pintasan, Ctrl + I.

paste curl command apidog — Tempel perintah cURL Anda di bidang kosong

Di sini, Anda dapat menempel perintah cURL Anda. Setelah Anda melakukannya, tekan Enter pada keyboard Anda atau tombol OK untuk melihat perintah cURL Anda.

curl code body edit apidog — Tentukan apakah Anda perlu memodifikasi hal lain

Jika berhasil, Anda dapat melihat perintah cURL sebagai bagian dari badan JSON, seperti yang ditunjukkan pada gambar di atas. Di sini, Anda dapat melakukan penyesuaian atau perubahan, di mana pun dan kapan pun diperlukan.

Pembuatan Kode Perintah cURL Menggunakan Apidog

curl comannd code generation apidog — Menghasilkan kode baris perintah cURL

Untuk memulai pembuatan kode cURL, temukan dan tekan tombol </> yang terletak di sudut kanan atas jendela Apidog. Kemudian, pilih Generate Client Code.

curl code generate apidog — Pilih kode baris perintah cURL menggunakan Apidog

Jendela pop-up akan meminta Anda untuk memilih kode klien mana yang akan dihasilkan. Di sini, pilih Shell dan cURL. Setelah Anda melakukannya, Anda dapat menyalin kode dan menempelkannya ke terminal Anda. Namun, pastikan Anda memodifikasinya agar sesuai dengan kebutuhan Anda.

Kesimpulan

SOAP cURLs adalah dua teknologi yang dapat bekerja bersama, di mana perintah cURL dapat digunakan untuk komunikasi layanan web berbasis SOAP. Namun, perlu dicatat bahwa penggunaannya menurun karena gaya arsitektur yang lebih populer seperti REST.

Apidog adalah platform pengembangan API all-in-one yang mempromosikan pengembangan yang mengutamakan desain untuk API. Dengan Apidog, Anda dapat dengan mudah memodifikasi dan mendesain API secara visual berkat UI-nya yang sederhana dan intuitif. Selain itu, ini adalah pilihan yang solid untuk setiap pengembang yang tertarik untuk mencoba platform baru karena Apidog mendukung berbagai impor jenis file, dengan Postman, WSDL, dan banyak lagi.