Install the PHP SDK

1. Initialize the client

All OpenAPI calls are made through a client object. Before you can make an API call, you must initialize the client. The client can be initialized in several ways. This example shows how to initialize the client using an AccessKey pair. For more information about other initialization methods, see Manage access credentials.

<?php

require_once 'vendor/autoload.php';
use AlibabaCloud\SDK\Devs\V20230714\Devs;
use Darabonba\OpenApi\Models\Config;

class Sample
{
    public static function createClient()
    {
        $config = new Config([
            // Required. Make sure that the ALIBABA_CLOUD_ACCESS_KEY_ID environment variable is set.
            "accessKeyId" => getenv("ALIBABA_CLOUD_ACCESS_KEY_ID"),
            // Required. Make sure that the ALIBABA_CLOUD_ACCESS_KEY_SECRET environment variable is set.
            "accessKeySecret" => getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET"),
            // Required. The endpoint of the Devs service. For more information, see https://api.aliyun.com/product/Devs.
            "endpoint" => "devs.cn-hangzhou.aliyuncs.com",
        ]);
        return new Devs($config);
    }
}

2. Create a request object for the operation

Before you make a call, you can view the API documentation for the operation to obtain parameter information.

// Prepare the name of the project to query.
$projectName = "my-devs-project"; // Replace this with the actual name of your project.

// Create a runtime configuration object.
$runtime = new RuntimeOptions();

3. Make the call

When you call an OpenAPI operation, you can set runtime parameters, such as timeout and proxy configurations. For more information, see Advanced configurations.

// Make the request.  
$response = $client->getProjectWithOptions($projectName, $headers, $runtime);

// Print the result.
echo json_encode($response->body, JSON_PRETTY_PRINT | JSON_UNESCAPED_UNICODE) . "\n";

4. Handle exceptions

The PHP SDK provides detailed exception categorization. To ensure the robustness of your program, you must handle potential exceptions when you call an API operation.

• TeaError: This exception type primarily handles business errors returned by the API, such as invalid parameters or resources that do not exist. You can use getCode() and getMessage() to retrieve specific error messages from the server for debugging.

• Exception: Other exceptions, such as network issues.

For more information about exception handling, see Exception handling.

5. Complete example

<?php

// Import the Composer autoloader file.
require_once __DIR__ . '/vendor/autoload.php';

// Import all required classes.
use AlibabaCloud\SDK\Devs\V20230714\Devs;
use Darabonba\OpenApi\Models\Config;
use AlibabaCloud\Dara\Models\RuntimeOptions;
use AlibabaCloud\Tea\Exception\TeaError;

/**
 * This is an example of how to use the Alibaba Cloud Devs SDK to query project information.
 */
class GetProjectSample
{
    public static function main()
    {
        try {
            // 1. Initialize the client.
            // The SDK automatically retrieves credentials from the ALIBABA_CLOUD_ACCESS_KEY_ID and ALIBABA_CLOUD_ACCESS_KEY_SECRET environment variables.
            $config = new Config([
                "accessKeyId"     => getenv("ALIBABA_CLOUD_ACCESS_KEY_ID"),
                "accessKeySecret" => getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET"),
                "endpoint"        => "devs.cn-hangzhou.aliyuncs.com",
            ]);
            
            $client = new Devs($config);

            // 2. Prepare the parameters for the API call.
            $projectName = "my-devs-project"; // Replace this with the actual name of your project.
            $runtime = new RuntimeOptions();
            $headers = [];

            // 3. Make the API call.
            $response = $client->getProjectWithOptions($projectName, $headers, $runtime);
            
            // 4. Handle a successful response.
            echo " API call successful!\n";
            // Use the standard PHP json_encode() function to print the object, and use JSON_PRETTY_PRINT to format the output.
            echo json_encode($response->body, JSON_PRETTY_PRINT | JSON_UNESCAPED_UNICODE) . "\n";

        } catch (Exception $error) {
            // 5. Handle exceptions.
            echo " API call failed!\n";
            if ($error instanceof TeaError) {
                echo "  Error Code: " . $error->getCode() . "\n";
                echo "  Error Message: " . $error->getMessage() . "\n";
                echo "  Request ID: " . ($error->data['RequestId'] ?? 'N/A') . "\n";
            } else {
                echo "  An unknown exception occurred: " . $error->getMessage() . "\n";
            }
        }
    }
}

// Run the main function.
GetProjectSample::main();