PHP

Scenarios

To use PHP to call an API through App authentication, obtain the PHP SDK, create a new project, and then call the API by referring to the API calling example.

This section uses IntelliJ IDEA 2018.3.5 as an example.

Preparing the Environment

• You have obtained the domain name, request URL, and request method of the API as well as the key and secret (or AppKey and AppSecret of the client) of the integration application. For details, see Preparations.
• You have installed IntelliJ IDEA 2018.3.5 or later. If not, download IntelliJ IDEA from the IntelliJ IDEA official website and install it.
• You have installed PHP 8.0.3 or later. If not, download the PHP installation package from the PHP official website and install it.
• Copy the php.ini-production file from the PHP installation directory to the C:\windows\ directory, rename the file as php.ini, and then add the following lines to the file:

  extension_dir = "PHP installation directory/ext"
  extension=openssl
  extension=curl

• You have installed the PHP plug-in on IntelliJ IDEA. If not, install the PHP plug-in according to Figure 1.
  Figure 1 Installing the PHP plug-in
  

Obtaining the SDK

Log in to the ROMA Connect console, choose API Connect > API Calling, and download the SDK. The directory structure after the decompression is as follows:

Creating a Project

1. Start IDEA and choose File > New > Project.

   On the displayed New Project page, choose PHP and click Next.

   Figure 2 New Project
   

2. Click ..., select the directory where the SDK is decompressed, and click Finish.
   Figure 3 Selecting the SDK directory after decompression
   

3. View the directory structure shown in the following figure.
   Figure 4 Directory structure of the new project
   

   Modify the parameters in sample code signer.php as required. For details about the sample code, see API Calling Example.

API Calling Example

1. Import the PHP SDK to your code.

   1	require 'signer.php';

2. Generate a new signer and enter the key and secret of the integration application.

   1 2 3

   $signer = new Signer(); $signer->Key = '4f5f626b-073f-402f-a1e0-e52171c6100c'; $signer->Secret = "******";

3. Generate a new request, and specify the method, request URL, and body.

   1 2	$req = new Request('GET', "https://c967a237-cd6c-470e-906f-a8655461897e.apigw.exampleRegion.com/app1?a=1"); $req->body = '';

4. Add the x-stage header to the request to specify an environment name. Add other headers to be signed as necessary.

   1 2 3

   $req->headers = array( 'x-stage' => 'RELEASE', );

5. Execute the following function to generate a $curl context variable.

   1	$curl = $signer->Sign($req);

6. If the subdomain name allocated by the system is used to access the API of HTTPS requests, ignore the certificate verification. Otherwise, skip this step.

   1 2	curl_setopt($curl, CURLOPT_SSL_VERIFYHOST, 0); curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, 0);

7. Access the API and view the access result.

   1 2 3 4

   $response = curl_exec($curl); echo curl_getinfo($curl, CURLINFO_HTTP_CODE); echo $response; curl_close($curl);