دليل فهرس واجهات برمجة التطبيقات لمؤسسات الملكية الفكرية

اجعلوا اكتشاف واجهات برمجة التطبيقات الخاصة بكم أسهل

يشرح هذا الدليل الكيفية التي يمكن بها لمؤسسات الملكية الفكرية توفير واجهات برمجة التطبيقات الخاصة بها من خلال فهرس واجهات برمجة التطبيقات الخاص بالملكية الفكرية.

ويمكن للفهرس عرض الواجهات تلقائياً بناءً على ملفات مواصفات الواجهات مفتوحة المصدر (OAS) المقدمة من مؤسسات الملكية الفكرية. وباتباع الخطوات أدناه، يمكنكم التأكد من تضمين واجهات برمجة التطبيقات الخاصة بكم في الفهرس.

ملاحظة: إذا لم تتمكنوا من إنتاج ملف OAS، فيرجى ملء نموذج EXCEL بالتفاصيل اللازمة وإرسالها إلينا عبر البريد الإلكتروني.

1. إنشاء ملف OAS لواجهة برمجة التطبيقات الخاصة بكم

للبدء، لا بد من إنشاء ملف OAS لواجهة برمجة التطبيقات الخاصة بكم مع تلبية المتطلبات الأساسية التالية:

الإصدار: يُرجى استخدام الإصدار 3.0.xمن OAS (يوصى بالإصدار 3.0.0).
النموذج: يُرجى استخدام النموذج المقدم (JSON, YAML) لضمان تلبية ملف OAS الخاص بكم المتطلبات الدنيا: (نموذج JSON، نموذج YAML).

الحد الأدنى من معايير البيانات لملف OAS

يعرض الجدول أدناه الحد الأدنى لمجموعة الحقول المطلوبة لملف OAS الخاص بكم.

ويُرجى ملاحظة أن هناك حقول امتداد OAS مُشار إليها بعلامة "x-" أدناه، وفقاً لمواصفات Swagger's Open API Extensions.

إذا لم تتمكنوا من ملء الحقول المحددة من النموذج، يُرجى ملء تلك الحقول على أنها "إدخال يدوي" في فهرس واجهات برمجة التطبيقات. وستتطلب التحديثات المستقبلية إضافة مخطط الامتداد إلى ملف OAS الخاص بكم لتجنب التحرير اليدوي.

حقول OAS	نوع البيانات	الوصف
openapi:	String	إصدار مواصفات واجهة برمجة التطبيقات مفتوحة المستخدم (يوصى باستخدام الإصدار 3.x.0).
:Info Object
- title:	String	اسم واجهة برمجة التطبيقات
- description:	String	وصف واجهة برمجة التطبيقات (يفضل أن يكون بنسق يصف حالات الاستخدام، على سبيل المثال توفر واجهة برمجة التطبيقات هذه إمكانية النفاذ إلى [الوظائف] حتى يتمكن المستخدمون من [الإجراءات]).
- version:	String	إصدار ملف OAS الخاص بكم لواجهة برمجة التطبيقات. نوصي باستخدام النسق 1.0.1
- x-oas-url:	String	رابط URL للصفحة التي سيكون ملف OAS متاحاً للتنزيل فيها (يسمح هذا للمكشطة الآلية بالتحقق من الصفحة بانتظام بحثاً عن أي تحديثات تُجرى على ملف OAS).
- x-product-page-url:	String	رابط URL لصفحة المنتج حيث توصف واجهة برمجة التطبيقات على موقعكم الإلكتروني (يضمن هذا إمكانية إحالة مستخدمي فهرس واجهة برمجة التطبيقات مباشرة إلى الواجهة التي يبحثون عنها).
- x-ip-domain	Array[String]	إدراج جميع مجالات نطاق الملكية الفكرية ذات الصلة بوظيفة واجهة برمجة التطبيقات هذه: البراءات، والعلامات التجارية، والتصاميم الصناعية، وحق المؤلف، والمؤشرات الجغرافية، وحماية الأصناف النباتية، والتصاميم التخطيطية للدوائر المتكاملة.
- x-service-type	Array[String]	إدراج جميع أنواع الخدمات التي يمكن أن توفرها واجهة برمجة التطبيقات: إدارة الحسابات، وإدارة التطبيقات، والاتصالات، والنشر، والدفع، وإدارة المحفظة، والتسجيل، والبحث، والترجمة (انظر أدناه للحصول على وصف مفصّل لكل من أنواع هذه الخدمات).
- x-content-type	Array[String]	إدراج جميع أنواع المحتوى التي يمكن لواجهة برمجة التطبيقات توفيرها: الملخص، والبيانات الببليوغرافية، وبيانات الاستشهاد، والمطالبات، والتصنيف، وقرار المحكمة، والوصف، وبيانات الأسرة، والنص الكامل، وبيانات الوضع القانوني، وبيانات الترخيص، وبيانات إجراءات المكتب، والبيانات المتعلقة بالدفع، وبيانات المصطلحات (انظر أدناه للحصول على وصف مفصّل لكل نوع من أنواع المحتوى هذه).
- x-content-language	Array[String]	إدراج جميع لغات المحتوى التي يمكن لواجهة برمجة التطبيقات الاستجابة بها، مفصولة بفاصلات، بنسق ISO 639-1 set 1.
- contact	Contact Object
:Contact Object
- email	String	البريد الإلكتروني لجهة الاتصال المعنية بواجهة برمجة التطبيقات.
- name	String	اسم المؤسسة
- URL	String	عنوان URL للصفحة الرئيسية لموقع فهرس واجهات برمجة التطبيقات الخاص بالمؤسسة أو بوابة المطور.
عناصر المسارات	Path Item Object	الاحتفاظ بالمسارات النسبية لنقاط النهاية الفردية وعملياتها. ويتم إلحاق المسار بعنوان URL من عنصر الخادوم من أجل إنشاء عنوان URL الكامل
/(لكل مسار...)
- summary:	String	ملخص مخصص للتطبيق على جميع العمليات في هذا المسار.
- get/put/post/delete		تعريف عمليات GET/PUT/POST/DELETE في هذا المسار.
- responses	Responses Object
-- HTTP Status Code	Response Object
--- description	String	وصف للاستجابة.
--- content	Map [String, Media Type Object]	نسق استجابة نوع المحتوى، على سبيل المثال application/json أو application/pdf، وما إلى ذلك.

2. نشر الملف OAS

يمكن نشر ملف OAS على موقعكم الإلكتروني باستخدام عنوان URL ثابت. ويُرجى التأكد أيضاً من عدم وجود أي مثبطات إضافية من شأنها أن تمنع النسخ المباشر لمواصفات OAS الخاصة بك. على سبيل المثال، نشر المواصفات كملف في نسق ZIP.

هام: إذا لم تتمكنوا من تضمين عنوان URL الخاص بملف OAS أو عنوان URL لصفحة منتج واجهة برمجة التطبيقات في ملف OAS الأولي الخاص بكم، فتذكروا تحديث ملف OAS باستخدام حقول OAS المذكورة أعلاه والمشار إليها بعلامة "x" وإعادة النشر كإصدار جديد. ولا تنسوا تحديث الإصدار للإشارة إلى أنكم أجريتم تلك التغييرات!

3. مشاركة عنوان URL الخاص بملف OAS مع المكتب الدولي

يُرجى إرسال عنوان URL الخاص بملف OAS الخاص بكم عبر البريد الإلكتروني إلى المكتب الدولي للويبو. وسيتم نسخ جميع المعلومات الأخرى المطلوبة تلقائياً باستخدام التفاصيل المقدمة في ملف OAS الخاص بكم.

4. التحقق من صحة إدخال واجهة برمجة التطبيقات الجديد عند استلامها

بعد إكمال الخطوة 3 أعلاه، ستتلقون بريداً إلكترونياً يحتوي على تفاصيل واجهة برمجة التطبيقات الخاصة بكم.

وفي البريد الإلكتروني، إذا كانت الحقول المطلوبة غير صحيحة أو فارغة، يٌرجى إضافة البيانات ذات الصلة إلى ملف OAS الخاص بكم وإعادة نشره قبل إعادة إرساله إلى المكتب الدولي.

ملاحظة: يٌرجى تحديث ملف OAS الخاص بكم بانتظام ليشمل جميع حقول البيانات المقترحة للحفاظ على "مصدر واحد للحقيقة". وهذا يضمن الاتساق ويقلل من الحاجة إلى التحديثات اليدوية.

المرشحات المتاحة لفهرس واجهة برمجة التطبيقات

يلخص الجدول التالي المرشحات المتاحة. ومن الممكن تحديد مرشح واحد أو أكثر في نفس الوقت. ومن الممكن تحديد مرشح واحد أو أكثر في نفس الوقت.

المرشح	الوظيفة	الخيارات
مجالات الملكية الفكرية	المرشحات حسب نوع محتوى الملكية الفكرية الذي يتم إرجاعه بواسطة واجهة برمجة التطبيقات	يمكن اختيار واحد أو أكثر مما يلي: البراءات العلامات التجارية التصاميم الصناعية حق المؤلف المؤشرات الجغرافية حماية الأصناف النباتية التصاميم التخطيطية للدوائر المتكاملة
نوع خدمة واجهة برمجة التطبيقات	المرشحات حسب نوع الخدمة أو الوظيفة التي تقدمها واجهة برمجة التطبيقات	يمكن اختيار واحد أو أكثر مما يلي: إدارة الحساب خدمة إنشاء وصيانة حساب المستخدم. إدارة الطلب خدمة إيداع طلب الملكية الفكرية، بما في ذلك إنشاء طلب الملكية الفكرية وإيداعه. الاتصالات الاتصالات بين مكاتب الملكية الفكرية وأصحاب الملكية الفكرية المعنيين، بما في ذلك الاتصالات المتعلقة بإجراءات المكتب مثل المودعين أو ممثليهم مثل الاتصالات المتعلقة بالفحص أو الاتصالات المتعلقة بالرسوم. النشر: نشر البيانات المختلفة مثل نشر طلب الملكية الفكرية، وبيانات الوضع القانوني، وبيانات قرار المحكمة، والملخص، وبيانات الاستشهاد، وبيانات التصنيف، وبيانات النص الكامل... الدفع خدمات الدفع للرسوم المختلفة مثل رسوم التقديم ورسوم التجديد. إدارة المحفظة خدمات إدارة محفظة الملكية الفكرية من طرف أصحاب حقوق الملكية الفكرية أو ممثليهم. للتسجيل الخدمات التي توفر معلومات متاحة للجمهور حول طلبات الملكية الفكرية، بما في ذلك التفاصيل الإجرائية. البحث خدمة استرجاع المعلومات بناءً على استعلامات محددة، مثل البحث عن الكلمات الرئيسية أو البحث عن رقم الطلب المودع. الترجمة خدمة ترجمة وثائق أو بيانات الملكية الفكرية.
نوع المحتوى	المرشحات حسب نوع المحتوى الراجع بواسطة واجهة برمجة التطبيقات	يمكن اختيار واحد أو أكثر مما يلي: ملخص ملخص موجز لمحتوى وثيقة الملكية الفكرية. البيانات الببليوغرافية المعلومات الوصفية حول وثيقة الملكية الفكرية. وتتضمن عادةً العنوان، والمودع أو المستفيد، وتاريخ الإيداع، وتواريخ النشر، وغير ذلك من التفاصيل الإدارية والإجرائية ذات الصلة. بيانات الاستشهاد الإشارات التي يتم إجراؤها بواسطة وثيقة البراءة إلى براءات سابقة (استشهادات البراءات) أو إلى وثائق غير البراءات (استشهادات NPL). المطالبات نطاق الحماية التي تمنحها البراءة، والذي يحدد النطاق الذي تغطية البراءة. التصنيف تصنيف وثائق الملكية الفكرية إلى فئات وفئات فرعية مختلفة بناءً على موضوعها. وتشمل التصنيف الدولي/التصنيف التعاوني للبراءات، ونيس للعلامات التجارية، ولوكارنو للتصاميم الصناعية. بيانات قرار المحكمة المعلومات والتفاصيل المتعلقة بالقرارات القانونية الصادرة عن المحاكم والتي تتعلق بمسائل الملكية الفكرية. الوصف شرح مفصل للاختراع. بيانات المجموعة مجموعة من وثائق الملكية الفكرية ذات الصلة والتي تنشأ من ملف أولي واحد. النص الكامل الوصف الكامل والمفصل للاختراع أو الإبداع في طلب براءة أو براءة اختراع ممنوحة. بيانات الوضع القانوني الوضع القانوني الحالي لطلب الملكية الفكرية المحدد مع أو بدون تاريخ الأحداث ذات الصلة بالوضع القانوني لطلب الملكية الفكرية؛ أو مجموعة البيانات الخاصة بأحداث الوضع القانوني لطلبات الملكية الفكرية التي حدثت خلال الفترة الزمنية المحددة مثل الأسبوع أو الشهر المحدد. وتُشجَّع المكاتب على تقديم المعلومات وفقاً لمعايير الويبو ST.27 أو ST.61 أو ST.87. بيانات الترخيص البيانات المتعلقة بترخيص الملكية الفكرية. بيانات إجراءات المكتب البيانات المتعلقة بإجراءات المكتب مثل تقرير البحث ونتيجة الفحص (على سبيل المثال، الرفض أو قرار المنح) أو الرد على إجراءات المكتب (على سبيل المثال، التعديل أو الحجج) أو معلومات الإدارة ذات الصلة (على سبيل المثال، تاريخ استحقاق الطلب أو دفع الرسوم). البيانات المتعلقة بالدفع البيانات المتعلقة بدفع الرسوم مثل العملة. بيانات المصطلحات المصطلحات والتعاريف المحددة المستخدمة في مجال الملكية الفكرية.
المؤسسة	المرشحات حسب المؤسسة التي تقدم واجهة برمجة التطبيقات	يمكنني اختيار لغة واحدة أو أكثر من المؤسسة المتاحة
لغة الاستجابة	المرشحات حسب لغة المحتوى الراجع من واجهة برمجة التطبيقات	يمكن اختيار لغة واحدة أو أكثر من اللغات المتاحة
نسق الاستجابة	المرشحات حسب نسق المحتوى الراجع من واجهة برمجة التطبيقات	يمكن اختيار واحد أو أكثر مما يلي: Json XML (TIFF, PNG,...) IMG PDF TXT DOCX Sound Multimedia 3D ZIP
بروتوكول واجهة برمجة التطبيقات	الترشيح حسب ما إذا كانت الواجهة تستخدم نهج REST أو SOAP	يمكن الاختيار بين النهجين التاليين: REST SOAP
عمليات واجهة برمجة التطبيقات	المرشحات حسب العمليات المتاحة عبر واجهة برمجة التطبيقات	يمكن اختيار واحد أو أكثر مما يلي: GET PUT POST DELETE

تفاصيل الاتصال

إذا كانت لديكم أي استفسارات أخرى حول فهرس برمجة التطبيقات، يُرجى الاتصال بنا.

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