پرش به مطلب اصلی

SDK زبان PHP

بسته Composer با نام ariaservice/arianet کلاینت رسمی PHP برای وب سرویس‌های آریانت است. به PHP نسخه ۸.۱ یا بالاتر با افزونه‌های curl و json نیاز دارد و وابستگی دیگری ندارد.

نصب​

composer require ariaservice/arianet

تا زمان ثبت بسته در Packagist، ابتدا مخزن GitHub را اضافه کنید:

composer config repositories.arianet vcs https://github.com/ariaservice/arianet-php
composer require ariaservice/arianet:^0.1

شروع سریع​

در پنل یک توکن شخصی API بسازید و آن را export کنید:

export ARIANET_TOKEN="paste-your-token-here"
<?php

require __DIR__ . '/vendor/autoload.php';

$client = new Arianet\Client(); // reads ARIANET_TOKEN

$page = $client->cloud->listServers(['per_page' => 50]);
foreach ($page['data'] as $server) {
echo $server['id'], ' ', $server['name'], ' ', $server['status'], PHP_EOL;
}

گروه‌های API​

ویژگیوب سرویس
$client->coreحساب، توکن‌ها، VPS، کلیدهای SSH، فایروال‌ها، موجودی و فاکتورها
$client->cloudابر آریانت
$client->regionalVpsVPS منطقه‌ای
$client->hostingهاستینگ
$client->baremetalسرور اختصاصی
$client->smsپیامک

نام متدها شکل camelCase همان operationId است. ترتیب آرگومان‌ها: پارامترهای مسیر، بدنه JSON (آرایه)، آرایه پارامترهای query و در آخر $options (idempotency_key، headers و region). هر متد پاسخ JSON را به صورت آرایه برمی‌گرداند.

$server = $client->cloud->createServer([
'name' => 'web-1',
'plan_id' => 101,
'image' => 'ubuntu-24.04',
'datacenter' => 'ovh',
]);

تنظیمات​

$client = new Arianet\Client('token', [
'base_url' => 'https://api.ariaservice.net', // default, or ARIANET_API_URL
'timeout' => 60.0,
'max_retries' => 3,
'max_retry_wait' => 60.0,
]);

max_retries تعداد تکرار و max_retry_wait بیشترین زمان انتظار (ثانیه) پیش از هر تکرار است. اگر Retry-After بیشتر از این مقدار باشد، RateLimitException بلافاصله پرتاب می‌شود. برای اینکه تکرار سفارش حتی بعد از ری‌استارت برنامه هم امن باشد، ['idempotency_key' => '...'] را در $options بفرستید.

مدیریت خطا​

use Arianet\ErrorCode;
use Arianet\Exception\ApiException;
use Arianet\Exception\ConnectionException;

try {
$client->core->createServer($order);
} catch (ApiException $e) {
if ($e->getErrorCode() === ErrorCode::INSUFFICIENT_BALANCE) {
// top up the wallet
}
error_log($e->getStatusCode() . ' ' . $e->getErrorCode() . ': ' . $e->getMessage());
} catch (ConnectionException $e) {
// no answer: DNS, TLS, timeout
}

هر وضعیت HTTP کلاس خطای خودش را در فضای نام Arianet\Exception دارد: AuthenticationException (۴۰۱)، PaymentRequiredException (۴۰۲)، PermissionDeniedException (۴۰۳)، NotFoundException (۴۰۴)، ConflictException (۴۰۹)، UnprocessableEntityException (۴۲۲)، RateLimitException (۴۲۹) و ServerException (۵xx)؛ همه از ApiException ارث می‌برند. getReason() در بعضی خطاها جزئیات بیشتری می‌دهد.

ریجن و endpointهای جدید​

$iran = $client->regionalVps->withRegion('iran-1');
$servers = $iran->listServers();

// Any path, with the same auth, retries and errors:
$client->request('GET', '/cloud/v1/new-endpoint', ['page' => 2]);