مرجع واجهة DeHub البرمجية — واجهتا REST وMastodon

لدى DeHub واجهتان برمجيتان عبر HTTP. الواجهة المتوافقة مع Mastodon هي الثابتة لتطبيقات الأطراف الثالثة. وواجهة REST الخاصة بـ DeHub تشغّل dehub.io وتطبيق الهاتف وتغطي كل الميزات.

عناوين URL الأساسية

المرجع الكامل لواجهة REST، مع كل نقطة نهاية وزر «جرّبها»، موجود في api.dehub.io/api/docxx. ملف OpenAPI المقروء آليًا موجود في api.dehub.io/api/docxx-json، جاهز لمولّدات الشيفرة وعملاء الواجهات البرمجية.

نقاط نهاية عامة للبدء

لا تحتاج إلى تسجيل الدخول:

# A profile, by handle or wallet
curl https://api.dehub.io/api/account_info/dehub

# The public feed
curl 'https://api.dehub.io/api/feed?limit=10'

# Search people and posts
curl 'https://api.dehub.io/api/search?q=music'

# The DHB leaderboard
curl https://api.dehub.io/api/leaderboard

# Public timeline, Mastodon format
curl 'https://riftn.com/api/v1/timelines/public?limit=20'

المصادقة

لواجهة Mastodon المتوافقة، احصل على رمز مستخدم عبر OAuth وأرسله بصيغة Authorization: Bearer TOKEN. تستخدم واجهة REST رموز الجلسات قصيرة العمر التي يحصل عليها dehub.io وتطبيق الهاتف عند تسجيل الدخول؛ وعلى تطبيقات الأطراف الثالثة أن تتصرف نيابة عن المستخدمين عبر الواجهة المتوافقة مع Mastodon.

حدود المعدّل

كل إجابة من REST تحمل حدودك الحالية:

x-ratelimit-limit-short: 20      # per 10 seconds
x-ratelimit-remaining-short: 19
x-ratelimit-limit-medium: 100    # per minute
x-ratelimit-limit-long: 500      # per 15 minutes
x-ratelimit-reset-long: 900

تُحسب الحدود لكل عنوان IP ولكل نقطة نهاية. عند تجاوز حدّ تحصل على 429 Too Many Requests؛ انتظر عدد الثواني في reset المطابق. لبعض نقاط النهاية حدود خاصة أشد، وتوجد نقاط نهاية مجمّعة للإجراءات الجماعية مثل متابعة كثير من الأشخاص.

الأخطاء

افحص حالة HTTP أولًا. تأتي الأخطاء بصيغة JSON بأحد هذه الأشكال:

{ "error": "Not Found: Account not found", "result": false }
{ "statusCode": 400, "message": "limit must be a number", "error": "Bad Request" }

تعيد الواجهة المتوافقة مع Mastodon الأخطاء دائمًا بالشكل { "error": "…" }، كما يتوقع عملاء Mastodon.

المعرّفات

يُعرَّف الأشخاص بعنوان محفظتهم بأحرف صغيرة (0x…)، وكذلك باسم المستخدم. للمنشورات معرّف رقمي يظهر في رابطها: dehub.io/app/post/7180.