Skip to main content
استخدم SDK عندما تتم كتابة التكامل الخاص بك باللغة TypeScript أو JavaScript ويتم تشغيله على الخادم.

ثَبَّتَ

pnpm add plato-api-sdk
استخدم مدير الحزم الذي يستخدمه مشروعك بالفعل:
npm install plato-api-sdk
yarn add plato-api-sdk
bun add plato-api-sdk

إنشاء عميل

import { createPlatoApiClient } from "plato-api-sdk";

export const plato = createPlatoApiClient({
  baseUrl: "https://api.plato.ae",
  apiKey: process.env.PLATO_API_KEY,
});
يقبل SDK إما أصل API أو نقطة النهاية tRPC الكاملة:
createPlatoApiClient({
  baseUrl: "https://api.plato.ae",
  apiKey: process.env.PLATO_API_KEY,
});

createPlatoApiClient({
  baseUrl: "https://api.plato.ae/api/trpc",
  apiKey: process.env.PLATO_API_KEY,
});

الطلب الأول

const feed = await plato.v1.orders.externalOrderFeed.query({
  apiKey: process.env.PLATO_API_KEY,
  date: "2026-06-17",
});

console.log(feed.count);
تقرأ معظم مسارات مفاتيح SDK API المفتاح من رأس التفويض الذي أنشأه SDK. تحتفظ بعض المسارات أيضًا بحقل إدخال apiKey من أجل التوافق. عندما تكون في شك، قم بتمرير المفتاح إلى عميل SDK واتبع أمثلة الإدخال في كل صفحة API.

تعطيل الخلط

تقوم طلبات دفعات SDK بشكل افتراضي. إذا كانت البيئة أو الوكيل يواجه مشكلة في طلبات tRPC المجمعة، فقم بتعطيل التجميع:
const plato = createPlatoApiClient({
  baseUrl: "https://api.plato.ae",
  apiKey: process.env.PLATO_API_KEY,
  batch: false,
});

رؤوس مخصصة

استخدم headers عندما تحتاج بيئتك إلى رؤوس طلبات إضافية.
const plato = createPlatoApiClient({
  baseUrl: "https://api.plato.ae",
  apiKey: process.env.PLATO_API_KEY,
  headers: {
    "x-request-source": "my-integration",
  },
});
يحافظ SDK على رأس المفتاح API في مكانه.