انتقل إلى المحتوى الرئيسي

ابدأ الآن

NPM VersionBundle Size

OneEntry Platform SDK هو SDK يوفر طريقة سهلة للتفاعل مع واجهة برمجة التطبيقات الخاصة بـ OneEntry Platform.

🚀 Quick Start

Get up and running with OneEntry in 3 simple steps:

1️⃣ Install the package

npm install oneentry

2️⃣ Initialize the SDK

import { defineOneEntry } from 'oneentry';

const api = defineOneEntry('your-project-url', {
  token: 'your-api-token',
  langCode: 'en_US'
});

3️⃣ Start using the API

// Fetch products
const products = await api.Products.getProducts({ limit: 10 });

// Get user profile
const user = await api.Users.getUser();

// Submit a form
const formData = await api.FormData.postFormsData('contact-form', {
  name: 'John Doe',
  email: 'john@example.com'
});

🎉 That's it! You're ready to build amazing applications with OneEntry.

🌐 الموارد​

✨ الميزات الرئيسية​

🔐
Secure Authentication

Built-in token management and OAuth support

🌍
Multi-language

i18n support with automatic language detection

📝
TypeScript

Full type definitions for better DX

⚡
Lightweight

Optimized bundle size for production

🔌
Modular Architecture

24 specialized modules for all your needs

🛡️
Error Handling

Custom error handlers and shell mode

📖 الاستخدام التفصيلي​

جميع الوحدات المتاحة​

استورد وفكك جميع الوحدات التي تحتاجها:



import { defineOneEntry } from 'oneentry'

const config = {
  token: 'your-app-token',
}
const {
  Admins,
  AttributesSets,
  AuthProvider,
  Blocks,
  Events,
  FileUploading,
  Forms,
  FormData,
  GeneralTypes,
  IntegrationCollections,
  Locales,
  Menus,
  Orders,
  Pages,
  Payments,
  ProductStatuses,
  Products,
  Settings,
  System,
  Templates,
  TemplatePreviews,
  Users,
  WS
} = defineOneEntry('your-url', config);

أو

const config = {
  token: 'your-app-token',
};

const api = defineOneEntry('your-url', config);

التكوين​

المعلمة الثانية من المُنشئ تأخذ 'config'. تحتوي على القيم التالية:

  • 'token' - قم بتعيين مفتاح الرمز إذا كان مشروعك مؤمنًا بـ "Security API Token". إذا كنت تستخدم حماية الشهادات، فلا تمرر هذه المتغير. يمكنك قراءة المزيد عن أمان مشروعك هنا.
  • 'langCode' - قم بتعيين "langCode" لتعيين اللغة الافتراضية. من خلال تحديد هذه المعلمة مرة واحدة، لا تحتاج إلى تمرير langCode إلى طرق واجهة برمجة التطبيقات ONEENTRY. إذا لم تقم بتمرير اللغة الافتراضية، فسيتم تعيينها إلى "en_US".
  • 'traficLimit' - تستخدم بعض الطرق أكثر من طلب واحد إلى OneEntry بحيث تكون البيانات التي تتلقاها كاملة وسهلة العمل بها. مرر القيمة "true" لهذه المعلمة لتوفير حركة المرور وقرر بنفسك ما هي البيانات التي تحتاجها. القيمة الافتراضية هي "false".
  • 'auth' - كائن بإعدادات المصادقة. بشكل افتراضي، يتم تكوين SDK للعمل مع الرموز داخل جلسة المستخدم ولا يتطلب أي عمل إضافي منك. في نفس الوقت، لا يخزن SDK حالة الجلسة بين الجلسات. إذا كنت راضيًا عن هذه الإعدادات، فلا تمرر المتغير 'auth' على الإطلاق.

يحتوي 'auth' على الإعدادات التالية:

  • 'refreshToken' - رمز التحديث الخاص بالمستخدم. قم بنقله هنا من المستودع لاستعادة جلسة المستخدم أثناء التهيئة.
  • 'saveFunction' - دالة تعمل مع تحديث رمز التحديث. إذا كنت ترغب في تخزين الرمز بين الجلسات، على سبيل المثال في التخزين المحلي، مرر دالة هنا تقوم بذلك. يجب أن تقبل الدالة معلمة سيتم تمرير السلسلة التي تحتوي على الرمز إليها.
  • 'customAuth' - إذا كنت ترغب في تكوين المصادقة والعمل مع الرموز بنفسك، قم بتعيين هذه العلامة إلى true. إذا كنت ترغب في استخدام إعدادات sdk، قم بتعيينها إلى false أو لا تمررها على الإطلاق.
  • 'providerMarker' - العلامة لمزود المصادقة. الافتراضي: 'email'. مثال على تكوين مع حماية الرمز والمصادقة التلقائية التي تخزن الحالة بين الجلسات
const tokenFunction = (token) => {
  localStorage.setItem('refreshToken', token);
};

const api = defineOneEntry('https://my-project.oneentry.cloud', {
  token: 'my-token',
  langCode: 'en_US',
  auth: {
    refreshToken: localStorage.getItem('refreshToken'),
    saveFunction: tokenFunction,
    providerMarker: 'email'
  },
});

مثال على تكوين محمي بشهادة يسمح لك بتكوين نظام المصادقة بنفسك ويحفظ البيانات على الطلبات.

const api = defineOneEntry('https://my-project.oneentry.cloud', {
  langCode: 'en_US',
  traficLimit: true,
  auth: {
    customAuth: true,
    refreshToken: localStorage.getItem('refreshToken'),
    providerMarker: 'email'
  },
});

إذا اخترت تكوين الرموز بنفسك، يمكنك تمرير الرمز إلى الطريقة كما يلي. تسمح لك الطريقة الوسيطة بتمرير رمز الوصول إلى الطلب. ثم استدعِ الطريقة المطلوبة. يجب عدم استدعاء هذه الطريقة (setAccessToken) إذا كانت الطريقة لا تتطلب مصادقة المستخدم.

const user = api.Users.setAccessToken('my.access.token').getUser();

إذا اخترت حماية الرمز لضمان أمان الاتصال، فقط مرر رمزك إلى الدالة كمعلمة اختيارية.

يمكنك الحصول على رمز كما يلي​

  1. قم بتسجيل الدخول إلى حسابك الشخصي
  2. انتقل إلى علامة التبويب "المشاريع" واختر مشروعًا
  3. انتقل إلى علامة التبويب "الوصول"
  4. قم بتعيين المفتاح إلى "Security API Token"
  5. قم بتسجيل الدخول إلى المشروع، وانتقل إلى قسم الإعدادات وافتح علامة التبويب الخاصة بالرمز
  6. احصل على رمز مشروعك وانسخه

يمكنك أيضًا توصيل شهادة tls لحماية مشروعك. في هذه الحالة، لا تمرر "token" على الإطلاق. عند استخدام الشهادة، قم بإعداد وكيل في مشروعك. مرر سلسلة فارغة كمعلمة url. تعرف على المزيد حول الأمان

const saveTokenFromLocalStorage = (token) => {
  localStorage.setItem('refreshToken', token);
};

const api = defineOneEntry('your-url', {
  token: 'my-token',
  langCode: 'my-langCode',
  auth: {
    customAuth: false,
    userToken: 'rerfesh.token',
    saveFunction: saveTokenFromLocalStorage,
    providerMarker: 'email'
  },
});

الأخطاء​

إذا كنت ترغب في الهروب من الأخطاء داخل sc، اترك خاصية "errors" كما هي بشكل افتراضي. في هذه الحالة، ستحصل إما على بيانات الكيان أو كائن الخطأ. تحتاج إلى إجراء تحقق من النوع. على سبيل المثال، من خلال التحقق من خاصية statusCode باستخدام ".hasOwnProperty"

ومع ذلك، إذا كنت ترغب في استخدام البناء "try catch(e) ", قم بتعيين الخاصية "isShell" إلى القيمة "false". في هذه الحالة، تحتاج إلى معالجة الخطأ باستخدام "try catch(e) ".

أيضًا، يمكنك تمرير دوال مخصصة سيتم استدعاؤها داخل sdk مع رمز الخطأ المناسب. تستقبل هذه الدوال كائن الخطأ كوسيط. يمكنك معالجته بنفسك.

const api = defineOneEntry('your-url', {
  token: 'my-token',
  langCode: 'my-langCode',
  errors: {
    isShell: false,
    customErrors: {
      400: (error) => console.error(error.message),
      404: (error) => console.error(error.message),
      500: (error) => console.error(error.message),
    },
  },
});

📚 الخطوات التالية​

استكشف أدلتنا الشاملة لمعرفة المزيد: