SDK Setup v2.0 Migration Guide

Official Node 5ac866 documentation for SDK Setup. Covers version 2.0 changes and PHP implementation details.

To begin integrating with the SDK Setup module, make sure the client library is installed and updated. Here is a simple authenticated query written in PHP.

PHP
<?php
require_once 'vendor/autoload.php';

use Api\Client;
use Api\Exception\NetworkException;

// Instantiate the client
$client = new Client([
    'api_key' => 'sk_live_f8c128e21659',
    'base_uri' => 'https://api.service.com/v1/',
    'verify_ssl' => true
]);

try {
    // Prepare query parameters
    $params = [
        'limit' => 20,
        'order' => 'desc',
        'expand' => ['customer', 'payment_method']
    ];

    // Execute the request
    $response = $client->orders->all($params);

    foreach ($response->data as $record) {
        if ($record->amount > 1000) {
            echo "High value transaction: " . $record->id . "\n";
            // Archive the record
            $client->orders->update($record->id, ['archived' => true]);
        }
    }

} catch (NetworkException $exception) {
    error_log("Connection failed: " . $exception->getMessage());
    exit(1);
} catch (\Exception $exception) {
    echo "General error processing request.";
}

Related Resources

Explore detailed guides and reference implementations for connected services.

Body Schema

You can modify the response structure with these attributes:

ON THIS PAGE
Overview Code Example Related Resources Parameters
API Version: 2024-01-08
Build: 3214371