توثيق API

دمج بحث لقطات الشاشة للأنيمي في تطبيقك عبر API العام.

الحصة المجانية

Signed-in users: 10 free credits per day (expire at midnight). After that, 1 credit per search. Upgrade for more.

ملاحظات المصادقة

تتطلب نقاط النهاية المعتمدة على الجلسة ملف تعريف ارتباط جلسة صالح. عند الاستدعاء من الخادم أو عملاء غير المتصفحات، قم بتضمين رأس Origin (مثال: Origin: https://your-domain.com) واحتفظ بملف تعريف الارتباط المُعاد من /api/auth/sign-in/email.

POST/api/anime/search

ابحث عن مشهد أنيمي عن طريق تحميل ملف صورة أو توفير رابط صورة. يُرجع ما يصل إلى 5 نتائج مطابقة مع الطوابع الزمنية ودرجات التشابه.

المصادقة: جلسة أو مفتاح API

المعلمات

الاسم	النوع	مطلوب	الوصف
image	File	لا	ملف صورة (JPEG/PNG)
url	string	لا	رابط صورة عام

Guests: 5/day by IP. Signed-in users: 10 daily free credits, then 1 credit per search, 100/hour.

Example

curl -X POST https://whatanimeisthis.com/api/anime/search \
  -F "url=https://example.com/screenshot.png"

curl -X POST https://whatanimeisthis.com/api/anime/search \
  -H "Authorization: Bearer <YOUR_API_KEY>" \
  -F "url=https://example.com/screenshot.png"

GET/api/anime/rankings

جلب ترتيب الأنيمي الأكثر بحثًا حسب الفترة.

المصادقة: لا شيء

المعلمات

الاسم	النوع	مطلوب	الوصف
period	string	لا	daily \| weekly \| monthly \| yearly \| all (الافتراضي: all)
limit	number	لا	الحد الأقصى للنتائج (الافتراضي: 50)
includeAdult	boolean	لا	تضمين محتوى للبالغين (الافتراضي: false)

لا يتطلب مصادقة.

Example

curl "https://whatanimeisthis.com/api/anime/rankings?period=daily&limit=10"

GET/api/anime/recent-searches

جلب أحدث عمليات البحث العامة المؤكدة.

المصادقة: لا شيء

المعلمات

الاسم	النوع	مطلوب	الوصف
limit	number	لا	الحد الأقصى للنتائج
offset	number	لا	إزاحة التصفح

نقطة نهاية عامة.

Example

curl "https://whatanimeisthis.com/api/anime/recent-searches?limit=5"

GET/api/user/anime-credits

الحصول على رصيد عمليات البحث المتبقي للمستخدم المسجل الحالي.

المصادقة: جلسة

للمستخدمين المسجلين فقط.

Example

curl "https://whatanimeisthis.com/api/user/anime-credits" \
  -H "Cookie: <SESSION_COOKIE>"

GET/api/apikeys

عرض مفاتيح API الخاصة بك.

المصادقة: جلسة

المعلمات

الاسم	النوع	مطلوب	الوصف
page	number	لا	رقم الصفحة
pageSize	number	لا	عدد العناصر في الصفحة

للمستخدمين المسجلين فقط.

Example

curl "https://whatanimeisthis.com/api/apikeys" \
  -H "Cookie: <SESSION_COOKIE>"

POST/api/apikeys

إنشاء مفتاح API جديد. يتم إرجاع المفتاح النصي مرة واحدة فقط.

المصادقة: جلسة

المعلمات

الاسم	النوع	مطلوب	الوصف
title	string	نعم	اسم وصفي للمفتاح

للمستخدمين المسجلين فقط.

Example

curl -X POST https://whatanimeisthis.com/api/apikeys \
  -H "Content-Type: application/json" \
  -H "Cookie: <SESSION_COOKIE>" \
  -d '{"title":"my-key"}'