/api/v4/sub-categoriesسرد الفئات الفرعية
يُرجع الكتالوج الكامل للفئات الفرعية المستخدمة لتصنيف المواقع عند إنشائها أو تحديثها.
المعلمات
لا تأخذ نقطة النهاية هذه أي معلمات.
الاستجابات
200The full list of subcategory objects.
{ "data": { "subcategories": [ { "databaseId": 639, "id": "U3ViQ2F0ZWdvcnk6NjM5", "key": "3d-printing", "name": "3D Printing", "primary": true }, { "databaseId": 4589, "id": "U3ViQ2F0ZWdvcnk6NDU4OQ==", "key": "3d-printing-service", "name": "3D printing service", "primary": true }, { "databaseId": 3268, "id": "U3ViQ2F0ZWdvcnk6MzI2OA==", "key": "aadhaar-center", "name": "Aadhaar center", "primary": true } ] }}401Unauthenticated, missing or invalid API key.
429Rate limit exceeded. Retry after the `Retry-After` header value.
يُرجع الكتالوج الكامل للفئات الفرعية التي تصنّف مجال نشاط الموقع. يُرجع هذا الحساب نحو 6,000 عنصر، لذا تعامل مع الكتالوج بوصفه مرجعًا كبيرًا وثابتًا في معظمه، واجلبه مرة واحدة وخزّنه مؤقتًا وحدّثه دوريًا بدلًا من استدعائه ضمن كل عملية إنشاء أو تحديث.
يتضمن كل عنصر ما يلي:
databaseId: العدد الصحيح الذي يجب تمريره فيsubCategoryIdعند إنشاء موقع أو تحديثه، وإدراجه في مصفوفةadditionalCategoryIdsللفئات الإضافية.id: معرّف Relay المرمّز بصيغة Base64 للسجل نفسه.key: صيغة مختصرة لاسم الفئة ملائمة للاستخدام في عناوين URL.name: التسمية المقروءة بشريًا.primary: ما إذا كانت الفئة مؤهلة لتكون الفئة الفرعية الأساسية لموقع.
تحديد معرّف الفئة قبل إنشاء موقع
عند إعداد موقع، عادةً ما تعرف نوع النشاط التجاري كنص حر ("خدمة الطباعة ثلاثية الأبعاد")، لكن createLocation يتوقع قيمة رقمية للحقل subCategoryId. النمط المتّبع هو: استرجاع هذه القائمة مرة واحدة، وإنشاء خريطة name → databaseId في شيفرتك، ثم البحث عن المعرّف عند الإنشاء.
const res = await fetch('https://listingsapi.com/api/v4/sub-categories', { headers: { Authorization: 'API ' + process.env.LISTINGSAPI_KEY },});const { data } = await res.json();const byName = new Map(data.subcategories.map((s) => [s.name.toLowerCase(), s.databaseId])); const subCategoryId = byName.get('3d printing service'); // 4589لتصنيف موقع ضمن أكثر من فئة، مرّر معرّف الفئة الأساسية في subCategoryId وما يصل إلى 9 معرّفات لفئات إضافية في additionalCategoryIds. راجع إنشاء موقع وتحديث موقع لمعرفة كيفية استخدام هذه الحقول.
الاستجابة عبارة عن مصفوفة واحدة غير مقسّمة إلى صفحات. ويُحتسب هذا الاستدعاء ضمن حد معدل الطلبات لحسابك مثل أي استدعاء آخر، لذا خزّن الاستجابة مؤقتًا بدلًا من إعادة جلبها لكل موقع؛ وتتضمن استجابة 429 ترويسة Retry-After.
curl -X GET 'https://listingsapi.com/api/v4/sub-categories' \ -H "Authorization: API $LISTINGSAPI_KEY"