Currixa.
اطلب عرضًا

أول نتاج في سبع خطوات

من مفتاح API إلى قراءة موثّقة المصدر.

أقسام الوثائق

تحذير

لا تضع المفتاح في الكود أو في المستودع أو في المتصفح، بل في متغير بيئة على الخادم وحده. إن تسرّب فألغِه فورًا من صفحة «المطوّرون».

الخطوات

  1. أنشئ تطبيقًا

    افتح «المطوّرون» في مساحة العمل، وأنشئ تطبيقًا، واختر نطاقات القراءة التي يحتاجها. الجهات التي يديرها المشغّل تبقى على عميل الخدمة.

  2. خذ مفتاحًا واحفظه سرًّا

    ابدأ بمفتاح تجربة: يقرأ المحتوى العام وحده، عشرة طلبات في الدقيقة. ثم مفتاح إنتاج. المفتاح يظهر مرة واحدة: ضعه في CURRIXA_API_KEY، متغير بيئة على الخادم، منفصلًا بين التطوير والإنتاج.

  3. اعرف مستأجرك

    المفتاح تابع لجهة واحدة؛ كل قراءة تُقيَّم داخلها ولا تعبر إلى غيرها.

  4. اختر النطاقات

    اطلب أقل ما يكفي: curriculum:read للقوائم، outcome:read للنتاجات، evidence:read للأدلة.

  5. اعرض الأطر

    يعيد GET /v1/frameworks الأطر التي يقرؤها مفتاحك، ومع كل إطار آخر نسخة منشورة منه، وصفوفه، وأين يُطبَّق.

    GET /v1/frameworks
    export CURRIXA_API_KEY="paste-your-key-here"
curl -s -H "Authorization: Bearer $CURRIXA_API_KEY" "https://api.currixa.net/v1/frameworks"

  6. اقرأ نتاجات إطار

    مرّر version بصيغة YYYY.N أو الكاملة YYYY.N.P؛ الرد يعيد النسخة المحلولة دائمًا.

    GET /v1/framework-outcomes
    curl -s -H "Authorization: Bearer $CURRIXA_API_KEY" "https://api.currixa.net/v1/framework-outcomes?framework=CURRIXA-ARA-NATIVE-V1&limit=5"

    تأخذ framework رمزًا من القائمة السابقة، مثل CURRIXA-ARA-NATIVE-V1. وللصفحة التالية أعد قيمة page.next_cursor في cursor.

  7. اتبع المصدر

    كل نتاج يحمل source_ref؛ تحقق من الطبعة والموضع قبل عرض المحتوى لمستخدميك.

الإصدار والحدود

خطتك تحدد طلباتك في الدقيقة وفي الشهر (راجع صفحة الأسعار)؛ ولمفتاح التجربة 10 طلبات في الدقيقة خاصة به. تجاوز أي حد 429 مع Retry-After.

صفحة الحدود