الوصول إلى الأوراق البحثية برمجياً عبر REST API الخاص بنا.
صديق لـ LLM: تم تفعيل CORS في API الخاص بنا، مما يسمح بالتكامل السلس مع وكلاء الذكاء الاصطناعي الخارجيين وأدوات المتصفح وسير العمل البحثي المؤتمت.
المصادقة
POST
/api/v1/auth?action=login
الحصول على رمز JWT للوصول إلى API.
{
"username": "your_username",
"password": "your_password"
}
// Response:
{
"success": true,
"data": {
"token": "eyJhbGciOiJIUzI1NiIs...",
"token_type": "Bearer",
"expires_in": 86400
}
}
البحث في الأوراق
GET
/api/v1/papers?q=transformer&category=cs.AI
البحث في الأوراق مع الفلاتر والترقيم.
curl "https://shelfhub.org/api/v1/papers?q=attention&page=1"
معلمات الاستعلام:
query
category - Filter by category (e.g., cs.AI)
tag - Filter by tag
author - Author name
page - Page number (default: 1)
per_page - Results per page (max: 100)
الحصول على تفاصيل الورقة
GET
/api/v1/papers?id=2503.12345
استرجاع بيانات التعريف الكاملة للورقة.
// Response:
{
"success": true,
"data": {
"paper_id": "2503.12345",
"title": "Paper Title",
"abstract": "Abstract text...",
"authors": [{"name": "Author Name"}],
"categories": [{"code": "cs.AI", "name": "AI"}],
"tags": ["llm", "transformer"],
"download_url": "/api/v1/download?id=2503.12345"
}
}
رفع ورقة
POST
/api/v1/papers
رفع ورقة جديدة مع بيانات التعريف.
// Headers:
Authorization: Bearer YOUR_JWT_TOKEN
Content-Type: multipart/form-data
// Form Fields:
title - Paper title (required)
abstract - Abstract text
authors - JSON array: [{"name": "..."}]
categories - JSON array: ["cs.AI", "cs.LG"]
tags - JSON array: ["llm", "attention"]
pdf - PDF file
تحميل الورقة
GET
/api/v1/download?id=2503.12345
تحميل ملف PDF مباشرة.
// CLI download:
curl -L -o paper.pdf \
"https://shelfhub.org/api/v1/download?id=2503.12345"
// Or use the CLI tool:
php preprint-cli.php download 2503.12345
الفئات والبيانات الوصفية
GET
/api/v1/meta?endpoint=categories
استرجاع الفئات والأوسمة الموجودة.
// Available endpoints:
GET /api/v1/meta?endpoint=categories
GET /api/v1/meta?endpoint=tags
GET /api/v1/meta?endpoint=stats
الصحة والحالة
GET
/api/v1/meta?endpoint=health
التحقق من توفر API وإصدار النظام.
// Response:
{ "success": true, "data": { "status": "ok", "version": "1.0.0" } }
الوصول بمفتاح API
لأدوات CLI وسير العمل المؤتمت، استخدم مفتاح API الخاص بك:
// Header format:
Authorization: Bearer YOUR_API_KEY
// Get your API key from profile after login.