Skip to main content
يقوم الـ SDK بمصادقة كل طلب باستخدام مفتاح API من نوع bearer. تنشئ YoukaClient مرة واحدة وتعيد استخدامه طوال عمر العملية (process) الخاصة بك.

​
new YoukaClient(options)

import { YoukaClient } from "@youka/ar/sdk";

const client = new YoukaClient({
  apiKey: process.env.YOUKA_API_KEY!,
});

​
الخيارات

​
apiKey
string
required
مفتاح API الخاص بـ Youka. أنشئ واحدًا من online.youka.io/account ضمن API keys.
​
fetch
typeof fetch
تنفيذ fetch مخصص. الإعداد الافتراضي هو fetch العام (global). استخدم هذا من أجل إدخال التسجيل (logging)، أو البروكسي، أو وسيط (middleware) مخصص لإعادة المحاولة.

​
تخزين مفتاح API

تمنح مفاتيح API صلاحية الوصول إلى الفوترة الخاصة بك. لا تقم أبدًا بإضافتها إلى نظام التحكم بالمصادر.
الأنماط الموصى بها: 
const client = new YoukaClient({
  apiKey: process.env.YOUKA_API_KEY!,
});

​
إدخال fetch مخصص

تستخدم كل طريقة في الـ SDK قيمة fetch التي تمررها إلى المُنشئ. هذا يجعل من السهل إضافة التسجيل أو وسيط: 
import { YoukaClient } from "@youka/ar/sdk";

const instrumentedFetch: typeof fetch = async (input, init) => {
  const start = Date.now();
  const response = await fetch(input, init);
  console.log(
    `${init?.method ?? "GET"} ${input} ${response.status} in ${Date.now() - start}ms`,
  );
  return response;
};

const client = new YoukaClient({
  apiKey: process.env.YOUKA_API_KEY!,
  fetch: instrumentedFetch,
});

​
خيارات لكل طلب

تقبل كل طريقة وسيطًا ثانيًا أو ثالثًا اختياريًا يحتوي على خيارات على مستوى الطلب: 
await client.projects.create(body, {
  idempotencyKey: "import-2026-04-08-song-001",
  signal: abortController.signal,
});
​
idempotencyKey
string
يتم تمريره كترويسة Idempotency-Key. يؤدي استخدام المفتاح نفسه مع الحمولة نفسها إلى إرجاع النتيجة الأصلية بدلًا من إنشاء نسخة مكررة. راجع API idempotency.
​
signal
AbortSignal
إشارة إلغاء قياسية. تُلغي الطلبات قيد التنفيذ وعمليات الاستطلاع طويلة الأمد client.tasks.wait(...), client.projects.wait(...), و client.exports.wait(...).

​
ما التالي

  • Projects — أنشئ مشروعك الأول
  • Errors — تعامل مع حالات فشل المصادقة
  • API authentication — تفاصيل ترويسات HTTP الخام