Help Center> DataArts Studio> SDK Reference> DataArts DataService SDK Reference> Calling APIs Through App Authentication> PHP
Updated on 2024-04-29 GMT+08:00
View PDF

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
becff4310645f3734344897ffdcabb1853d4b7d93b59a6ea187c5ae40543b36b
CertUtil: -hashfile command executed.
becff4310645f3734344897ffdcabb1853d4b7d93b59a6ea187c5ae40543b36b

    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

    becff4310645f3734344897ffdcabb1853d4b7d93b59a6ea187c5ae40543b36b

    Go

    bcf8cf19a21226e247195f2e584c8414da39b8d05840fb02948e1375d9bbb7e6

    Python

    c3da3b5814f828d6217963e856563d558d938b3da28993a8a13c8a7ebff5b95d

    C#

    a880b47e63ab35bfe216592e340a8135b866aef8f756ef7738fff3287885f33a

    JavaScript

    53261387f5fcf46e61d0bef5e890bea97952717f327c356412c3128389e848d6

    PHP

    29bf711144e77a4adaea1257cd6dedd2220e57b729a8fd000c51e68ccb42ad4b

    C++

    f604c6386c62cccb7c358007778037d5b15480987dc2860eef1b7bad37cb21d7

    C

    7086012c2d0569d5938830926b19fbea0d46682a983e04e52924978e8720c2f8

    Android

    89962b186707828b06b0c9f50c010b2f4cefd6a8e7ca9bdefb616bbbf6e739c8

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
4
5
6
7
8
    		 
    // Coded or plaintext AK and SK pose significant security risks. To ensure security, encrypt your AK and SK, store them in configuration files or environment variables, and decrypt them when needed.
// In this example, the AK and SK stored in the environment variables are used for identity authentication. Before running this example, configure environment variables SDK_AK and SDK_SK in the local environment.
$ak = getenv('SDK_AK');
$sk = getenv("SDK_SK");

$signer = new Signer();
$signer->Key = $ak;
$signer->Secret = $sk;

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