تخطَّ إلى المحتوى

جلب قواعد القناة ومخطط إعداداتها

GET /public/v1/integration-settings/{id}

يصف ما تقبله قناة واحدة: كم يطول المنشور، وما الذي يجب أن يحتويه كائن settings الخاص بها، وقواعد المنصة التي يفرضها شارك، وأي أدوات تستطيع استدعاءها عليها.

استدعه حين تريد بناء منشور بشكل صحيح دون ترميز مخطط مزود في الكود، ولاكتشاف قيم methodName اللازمة لـ تشغيل أداة قناة.

وهذه العملية متاحة أيضًا بالأمر sharek integrations:settings في أداة CLI من شارك، وبالأداة integrationSchema في خادم MCP من شارك، وهي تأخذ اسم مزود لا معرف قناة.

المعامل مطلوب الوصف
id نعم معرف التكامل من سرد القنوات.
Terminal window
curl -H "Authorization: your-api-key" \
https://dash.sharek.app/api/public/v1/integration-settings/channel-id
{
"output": {
"rules": "Text describing what this platform allows.",
"maxLength": 280,
"settings": { "...": "JSON schema for this provider's settings object" },
"tools": [
{
"methodName": "subreddits",
"description": "Get list of subreddits with information",
"dataSchema": [
{ "key": "word", "type": "string", "description": "Search subreddit by string" }
]
}
]
}
}
الحقل الوصف
rules قواعد النشر على المنصة بصيغة مقروءة للإنسان.
maxLength حد الأحرف الذي يفرضه شارك لهذه القناة. وقد يعتمد على الحساب: فقد يحصل حساب موثق على حد أعلى من غير الموثق على المنصة نفسها.
settings مخطط التحقق لكائن settings الخاص بالمزود. وحين لا يأخذ المزود أي خيارات، تكون قيمته النص "No additional settings required" لا كائنًا، فتحقق من النوع قبل التحليل.
tools الأدوات التي تتيحها هذه القناة، لكل منها methodName الذي تستدعيه وشكل data الخاص بها. وهي فارغة عند كثير من المزودين.
  • maxLength يقرأ لكل قناة لا لكل مزود، ولهذا تأخذ هذه العملية معرف قناة لا اسم مزود.
  • معرف قناة غير موجود، أو يخص مؤسسة أخرى، يعيد 404 {"msg": "Integration not found"}.
  • المخططات الثابتة لكل مزود مكتوبة أيضًا في صفحة لكل مزود، وكلها مرتبطة من القنوات التي يوفرها شارك. استخدم تلك للقراءة؛ واستخدم هذه العملية حين تريد الجواب الحي لقناة بعينها.