کتابخانه‌های رسمی

هر دو کتابخانه تمام endpoint‌ها را پوشش می‌دهند، خطاها را به کلاس تبدیل می‌کنند، صفحه‌بندی را خودکار انجام می‌دهند و امضای وب‌هوک را تأیید می‌کنند.

Node.js

@aiproxy/sdk

bash

npm install @aiproxy/sdk

Node 18 یا بالاتر

PHP

aiproxy/sdk

bash

composer require aiproxy/sdk

PHP 8.1 یا بالاتر — با Laravel هماهنگ

ساختار

متدها در شش فضای نام گروه‌بندی شده‌اند:

client.jobsارسال و پیگیری پردازش

estimate · create · retrieve · list · iterate · cancel · wait · run · content · stream · preview · download

client.filesآپلود دارایی قابل استفادهٔ مجدد

upload · preview

client.catalogابزارها، تعرفه‌ها و وضعیت سرویس

tools · tool · plans · packs · limits · status

client.accountکیف پول، مصرف و کلیدها

wallet · usage · profile · updateProfile · keys

client.paymentsخرید اشتراک و اعتبار

checkout · history

client.webhooksرویدادها و تأیید امضا

list · create · update · delete · test · deliveries · constructEvent

تنظیمات

const client = new Client({
  apiKey: process.env.API_KEY,
  baseUrl: 'https://aidoom.ir/api',
  timeoutMs: 30_000,
  maxRetries: 2,

  // هدر اضافه روی هر درخواست (مثلاً برای ردیابی)
  headers: { 'x-trace-id': traceId },

  // قلاب‌های مشاهده‌پذیری
  onRetry:    ({ attempt, delayMs }) => log.warn({ attempt, delayMs }),
  onResponse: ({ path, status, durationMs }) => metrics.observe(path, status, durationMs),
});

لغو درخواست

const ctrl = new AbortController();
setTimeout(() => ctrl.abort(), 5000);

await client.jobs.run('face-swap', params, { signal: ctrl.signal });

تغییر نام هدر امضا

اگر سرویس شما هدر امضا را با نام دیگری ارائه می‌دهد، قابل تنظیم است:

const client = new Client({
  apiKey: '...',
  brand: { slug: 'acme', signatureHeader: 'acme-signature' },
});

تلاش مجدد امن. درخواست POST فقط وقتی تکرار می‌شود کهIdempotency-Key داشته باشد، تا قطعیِ شبکه پس از پذیرش کار باعث کسر دوبارهٔ اعتبار نشود.