المصادقة – توثيق واجهة ByByBG API
🔐 المصادقة

مصادقة واجهة API

قم بربط تطبيقاتك ومواقعك وأنظمتك الخلفية بأمان باستخدام مفتاح ByByBG API الخاص بك.

عرض الأسعار دليل الويب / HTML
المصادقة

المصادقة باستخدام مفتاح API

يجب أن تتضمن جميع الطلبات المرسلة إلى واجهة ByByBG API مفتاح API صالحًا داخل ترويسات الطلب.

يحدد مفتاح API الخاص بك حسابك وحدود الطلبات وخطة الاشتراك الخاصة بك بشكل آمن.

STEP 1

إنشاء مفتاح API الخاص بك

سجّل الدخول إلى لوحة التحكم الخاصة بك وأنشئ مفتاح API خاصًا من قسم إعدادات المطور.

مهم: لا تشارك مفتاح API الخاص بك علنًا أبدًا ولا تعرضه داخل تطبيقات الواجهة الأمامية.
STEP 2

إرسال مفتاح API في ترويسات الطلب

قم بتضمين مفتاح API الخاص بك باستخدام ترويسة X-API-KEY في كل طلب API. 

X-API-KEY: YOUR_API_KEY
PHP EXAMPLE

مثال مصادقة PHP

مثال PHP أساسي يوضح كيفية تضمين مفتاح API في ترويسات الطلب. 

<?php

$apiKey = "YOUR_API_KEY";

$headers = [
    "X-API-KEY: ".$apiKey
];
CURL EXAMPLE

مثال مصادقة cURL

مثال بسيط لطلب cURL مصادق عليه لاختبار الواجهة بسرعة. 

curl -X POST https://api.bybybg.com/v1/remove-bg \
-H "X-API-KEY: YOUR_API_KEY" \
-F "file=@image.png"
SECURITY

أفضل ممارسات الأمان

  • لا تعرض مفاتيح API داخل أكواد JavaScript الخاصة بالواجهة الأمامية.
  • قم بتخزين مفاتيح API بأمان داخل متغيرات البيئة.
  • قم بتغيير مفاتيح API الخاصة بك بشكل دوري لتعزيز الأمان.
  • استخدم أنظمة Proxy خلفية لتطبيقات الواجهة الأمامية.
  • قيّد الوصول غير المصرح به إلى أنظمتك الخلفية.
COMMON MISTAKES

أخطاء المصادقة الشائعة

  • استخدام مفتاح API غير صالح أو منتهي الصلاحية.
  • إرسال الطلبات دون ترويسات المصادقة.
  • كشف مفاتيح API السرية علنًا على مواقع الويب.
  • استخدام أسماء ترويسات أو تنسيقات غير صحيحة.
ERRORS

أخطاء المصادقة

Status
Description
401
مفتاح API مفقود أو غير صالح.
403
تم رفض الوصول لهذا الطلب.
429
تم تجاوز حد الطلبات المسموح به لحسابك.

هل أنت جاهز لدمج الواجهة؟

تابع إلى دليل الويب / HTML وتعلّم كيفية بناء أول تطبيق لإزالة الخلفية بالذكاء الاصطناعي.

دليل الويب / HTML عرض دليل الأخطاء