SOAP API Call Examples in PHP

Understanding SOAP API Calls in PHP

SOAP (Simple Object Access Protocol) is a protocol used to exchange structured information in the implementation of web services. It relies on XML for its message format and usually operates over HTTP or SMTP. In this article, we will look at three diverse examples of making SOAP API calls in PHP, suitable for various use cases.

Example 1: Fetching Weather Data from a SOAP API

Context

In this example, we will create a PHP script that calls a SOAP API to get weather data for a specific location. This can be useful for applications that need to display weather information to users.

// Define the SOAP client with the WSDL URL
defined('SOAP_WSDL') or define('SOAP_WSDL', 'http://www.webservicex.net/globalweather.asmx?WSDL');

try {
    // Create a SOAP client
    $client = new SoapClient(SOAP_WSDL);
    // Call the GetWeather method with parameters
    \(response = \)client->GetWeather(['CityName' => 'New York', 'CountryName' => 'United States']);
    // Output the result
    echo 'Weather Data: ' . $response->GetWeatherResult;
} catch (SoapFault $fault) {
    // Handle any errors
    echo 'Error: ' . $fault->getMessage();
}

Notes

• Ensure that the WSDL URL is accessible from your server.
• You can modify the city and country parameters to fetch data for different locations.

Example 2: User Authentication via SOAP API

Context

This example demonstrates how to authenticate a user against a SOAP API. It is particularly useful in applications requiring secure user login.

// WSDL URL for the authentication service
define('AUTH_WSDL', 'https://example.com/auth_service?wsdl');

try {
    // Create a new SOAP client
    $client = new SoapClient(AUTH_WSDL);
    // Prepare the authentication parameters
    $params = ['username' => 'testUser', 'password' => 'testPass'];
    // Call the AuthenticateUser method
    \(response = \)client->AuthenticateUser($params);
    // Check the response for success
    if ($response->AuthenticateUserResult) {
        echo 'User authenticated successfully!';
    } else {
        echo 'Authentication failed!';
    }
} catch (SoapFault $fault) {
    // Handle any errors
    echo 'Error: ' . $fault->getMessage();
}

Notes

• Replace the WSDL URL with the actual URL of your authentication service.
• The username and password should be securely managed in a real application.

Example 3: Retrieving Product Information from an E-commerce SOAP API

Context

In this example, we will retrieve product information from an e-commerce SOAP API. This is useful for applications that need to display product details dynamically.

// E-commerce SOAP API WSDL URL
define('PRODUCT_WSDL', 'https://api.example.com/ecommerce?wsdl');

try {
    // Create the SOAP client
    $client = new SoapClient(PRODUCT_WSDL);
    // Call the GetProductInfo method with a product ID
    $productID = 12345;
    \(response = \)client->GetProductInfo(['productID' => $productID]);
    // Display product information
    echo 'Product Name: ' . $response->GetProductInfoResult->ProductName . '\n';
    echo 'Price: ' . $response->GetProductInfoResult->Price . '\n';
} catch (SoapFault $fault) {
    // Handle any errors
    echo 'Error: ' . $fault->getMessage();
}

Notes

• Ensure that the product ID corresponds to a valid product in the database.
• Depending on the API, the structure of the returned data may vary, so adjust the output code accordingly.

By following these examples of example of SOAP API call in PHP, you can integrate SOAP web services into your PHP applications effectively.