نظرة عامة

تتيح واجهة API لشركاء أنيس لنظامك الخاص أن يشتري بطاقات أنيس ويسلّمها لعملائك: أن يقرأ محافظك والكتالوج، ويقدّم طلبات الشراء، ويقرأ رموز البطاقات التي اشتريتها. تشرح هذه الصفحة كيف تترابط هذه الأجزاء قبل أن وتدخل بقية صفحات دليل الاستخدام في التفاصيل.

الأطراف

  • تطبيقك — ما يُنشئه لك موظفو أنيس. له صلاحيات (أي الاستدعاءات يحق له إجراؤها)، والشبكات التي يجوز له الاستدعاء منها، وحدود اختيارية، والمحافظ التي يجوز له استخدامها.
  • حسابك التجاري لدى أنيس — الحساب الذي تتبع له المحافظ. تُدفع المشتريات من محافظه.
  • مفتاحك — زوج مفاتيح تُنشئه بنفسك. لا يغادر النصف الخاص جهتك أبدًا؛ ولا يرى أنيس إلا النصف العام. يمكن استبدال مفتاح التطبيق دون تغيير أي شيء آخر.

كل استدعاء موقّع، وكل ردّ يُتحقَّق منه

لا يوجد مفتاح API ترسله. بدلًا من ذلك:

  1. أنت توقّع كل استدعاء بمفتاحك الخاص. يفحص أنيس التوقيع، ويرفض كل ما لا يستطيع التحقق منه، قبل أن ينظر فيما طلبته.
  2. أنيس يوقّع كل ردّ بمفتاحه هو. يفحص برنامجك (client) ذلك التوقيع ويتخلّص من الردّ إذا فشل التحقق منه — فلا يُبنى أي إجراء أبدًا على ردّ مزوّر أو معدَّل.

التوقيع دقيق حتى مستوى البايت، ولهذا نوفّر حزم SDK التي تقوم به نيابةً عنك. إن كتبت برنامجك بنفسك، فإن دليلَي التوقيع والتحقق يقدّمان كل قاعدة.

ما يمكنك فعله

المجال الاستدعاءات
تطبيقك قراءة ملفك التعريفي وصلاحياتك الحالية
المحافظ عرض قائمة محافظك وأرصدتها
الكتالوج تصفّح الفئات والفئات الفرعية والبطاقات التي يمكن لمحفظة ما شراؤها، مسعّرةً لتلك المحفظة
طلبات الشراء تقديم طلب شراء، واستئناف طلب لم تتلقَّ نتيجته، وقراءة الحالة التي وصل إليها طلب الشراء
البطاقات المملوكة عرض قائمة البطاقات المشتراة، وكشف رموز بطاقة واحدة أو فاتورة كاملة
التشخيص فحص توقيعك: يُبلغك أنيس بما رآه بالضبط

يسرد مرجع API كل استدعاء مع صلاحيته وحقوله وحالات رفضه.

لا يمكن أن يُشترى طلب مرتين بالخطأ

تختار معرّف عملية لكل طلب شراء وتحتفظ به. إرسال المعرّف نفسه مرة أخرى لا يؤدي أبدًا إلى الشراء مرتين: بل يستأنف طلب الشراء نفسه ويعيد نتيجته الفعلية. وهذا ما يجعل إعادة المحاولة بعد انتهاء المهلة آمنة. راجع طلبات الشراء والاستعادة.

عنوان واحد، ولا شيء آخر لإعداده

يعطيك أنيس العنوان الذي تستدعيه. كل نسخة نشر لأنيس نسخة منفصلة تمامًا — لها عنوانها ومفاتيحها وبياناتها — لذا لا يوجد إعداد “بيئة” (environment) في أي مكان: العنوان وحده هو ما يحدد النسخة التي تتعامل معها، والمفتاح المسجَّل لدى إحداها لا يعني شيئًا لأخرى.

الحصول على الوصول

يُنشئ موظفو أنيس تطبيقك، ويضبطون صلاحياته وشبكاته وحدوده، ويرسلون إليك دعوة لتسجيل مفتاحك الأول. ابدأ بـتسجيل مفتاح.