Updated on 2023-05-24 GMT+08:00

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 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 to be called, and the AppKey and AppSecret of the App for calling the API. For more information, see Preparation.
  • You have installed IntelliJ IDEA. If not, download IntelliJ IDEA from the official IntelliJ IDEA website and install it.
  • You have installed the PHP programming language. If not, download the PHP installation package from the official PHP 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:
    1
    2
    3
    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

  1. Log in to the DataArts Studio console.
  2. Click DataArts DataService.
  3. In the navigation pane, choose DataArts DataService Exclusive > SDKs.
  4. On the SDKs page, download the SDK package.
  5. Verify integrity of the SDK package. In Windows, open the CLI and run the following command to generate the SHA-256 value of the downloaded SDK package. In the command, D:\java-sdk.zip is an example local path and name of the SDK package. Replace it with the actual value.

    certutil -hashfile D:\java-sdk.zip SHA256

    The following is an example command output:

    SHA-256 hash value of D:\java-sdk.zip
    a7c0195ebf297f29ab0065da16d7e84f14911de177e6e0c8dbadf3464d12b75f
    CertUtil: -hashfile command executed.

    Compare the SHA-256 value of the downloaded SDK package with that provided in the following table. If they are the same, no tampering or packet loss occurred during the package download.

    Language

    SHA-256 Value of the SDK Package

    Java

    a7c0195ebf297f29ab0065da16d7e84f14911de177e6e0c8dbadf3464d12b75f

    Go

    caf22350181a4ecd49dc0d3f56097b10c1794792adae407140950be4ed9b6771

    Python

    c80b9ef282fc88d3fb16db4cb9d7525d3db71f7989782ed0b636920ea2fadb93

    C#

    b0e69ef60a561c54c1b86c3447ca855088a1fa2a672fbfba618aaf56b2841e8a

    JavaScript

    c64e595651de079766e446ce2c3262013256f81683bb9434bee27bed3a4caf01

    PHP

    e2eba2cae72aea794edb4057ed8eb7cb82f0dbaccabf9c5539694a7a7a9f3c89

    C++

    c173f59d816aba53f47750cf5ffdc65cc345b1613974b3d2a545ace48787f577

    C

    e4f22beb7b132fe6e57c9de79f596c3ff830228cd7221b02ca96198e501c642c

    Android

    d6c3032801ac88cf8cbc51f64d42457174447c8d159f34a187c036913b31ea2b

Obtain the ApiGateway-php-sdk.zip package. The following table shows the files decompressed from the package.

Name

Description

signer.php

SDK code

index.php

Sample code

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 AppKey and AppSecret.

    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://{apig-endpoint}/app1?a=1");
    $req->body = '';
    

  4. Add a header to the request. The header contains specific parameters. Add other headers to be signed as necessary. host is mandatory. Enter the request URL. The following is an example:

    1
    2
    3
    $req->headers = array(
        'host' => '{apig-endpoint}'
    );
    

  5. Execute the following function to generate a $curl context variable. Then, add the x-Authorization header to the request. The value of the x-Authorization header is the same as that of the Authorization header.

    1
    2
    3
    4
    5
    6
    7
    $curl = $signer->Sign($req);
    $req->headers['x-Authorization'] = $req->headers['Authorization'];
    $header = array();
    foreach ($req->headers as $key => $value) {
        array_push($header, strtolower($key) . ':' . trim($value));
    }
    curl_setopt($curl, CURLOPT_HTTPHEADER, $header);
    

  6. 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);