واجهة برمجة تطبيقات pseudonymize.io

مرحبًا بك في وثائق pseudonymize.io. ضع واجهة برمجة التطبيقات هذه في مسار بياناتك الحساسة قبل أن تصل إلى الأنظمة الخارجية (مثل LLMs أو مستودعات التحليلات أو أدوات دعم الطرف الثالث).

البداية السريعة

أرسل طلبًا إلى Text API للحصول على اسم مستعار للنثر.

curl -X POST https://api.pseudonymize.io/text \
  -H "Authorization: Bearer ps_live_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "text": "Alice Rossi disputed invoice INV-204 from [email protected]",
    "policy": "default"
  }'

إجابة:

{
  "text": "PERSON_01 disputed invoice INV-204 from EMAIL_01",
  "entities": [
    { "type": "PERSON", "original": "Alice Rossi", "pseudonym": "PERSON_01" },
    { "type": "EMAIL", "original": "[email protected]", "pseudonym": "EMAIL_01" }
  ]
}

المصادقة

يجب أن تتضمن جميع طلبات واجهة برمجة التطبيقات (API) مفتاح واجهة برمجة التطبيقات (API) الخاص بك في رأس "التفويض".

Authorization: Bearer ps_live_...

يتم إنشاء مفاتيح API بالتنسيق ps_live_.... من أجل أمانك، يتم عرض المفتاح السري الكامل مرة واحدة فقط عند الإنشاء. لا يقوم pseudonymize.io أبدًا بتخزين مفاتيح واجهة برمجة التطبيقات في نص عادي - يتم الاحتفاظ فقط بتجزئة تشفير غير قابلة للعكس (SHA-256) وبادئة تعريف قصيرة (ps_live_XXXX).

يمكنك إدارة مفاتيح واجهة برمجة التطبيقات (API) الخاصة بك في لوحة المعلومات.

واجهة برمجة التطبيقات النصية

POST https://api.pseudonymize.io/text (متاح أيضًا عبر POST https://api.pseudonymize.io/v1/text و/api/v1/text)

يستبدل المعرفات داخل النثر دون تسطيح النص من حولهم.

نص الطلب

• نص (سلسلة، مطلوبة): النص المطلوب معالجته.
• السياسة (سلسلة، اختيارية): السياسة التي سيتم استخدامها. الإعدادات الافتراضية هي "الافتراضي".
• اكتشاف (صفيف، اختياري): أنواع كيانات محددة للكشف عنها.

{
  "text": "Call me at +39 333 1234567.",
  "detect": ["PHONE"]
}

واجهة برمجة تطبيقات البيانات المنظمة

POST /api/v1/data

قم بإضافة أسماء مستعارة لحقول المعرفات مع إبقاء الصفوف والمخططات قابلة للاستخدام.

نص الطلب

• الحمولة (الكائن | المصفوفة، مطلوبة): بنية JSON المراد معالجتها (يمكن أيضًا تمريرها كـ بيانات).
• السياسة (سلسلة، اختيارية): السياسة التي سيتم استخدامها. الإعدادات الافتراضية هي "الافتراضي".
• اكتشاف (صفيف، اختياري): أنواع كيانات محددة للكشف عنها.

{
  "payload": {
    "user": {
      "name": "Mario Rossi",
      "email": "[email protected]"
    }
  },
  "detect": ["PERSON", "EMAIL"]
}

حجز الفواتير والائتمان

يعمل موقع Pseudonymize.io وفق نموذج شفاف للدفع عند الاستخدام:

• €1 لكل مليون رمز مُقاس. يُقرَّب كل طلب ناجح إلى أعلى بمضاعفات 1,000 رمز (رصيد واحد)، بحد أدنى €0.001.
• الحجز قبل الرحلة: يتم حجز الأرصدة ذريًا عند حدود البوابة قبل وصول الحمولات إلى المحرك الأساسي. إذا كان الحساب يحتوي على أرصدة غير كافية، فإن واجهة برمجة التطبيقات (API) تُرجع 402 Payment Required على الفور دون إعادة توجيه بيانات العميل.
• ضمان استرداد الأموال تلقائيًا: في حالة فشل مكالمة المعالجة الأساسية أو انتهاء المهلة، يتم استرداد الأرصدة المحجوزة بالكامل على الفور.

الأسماء المستعارة والهوية الحتمية

يستخدم Pseudonymize.io الحفاظ على الهوية الحتمية ضمن طلب واحد. إذا ظهرت "Alice" ثلاث مرات في نفس المستند، فإنها تصبح "PERSON_01" جميعها ثلاث مرات. وهذا يسمح لـ LLMs بفهم أنه نفس الشخص دون معرفة من هو.

الأخطاء والحدود

نحن نستخدم رموز حالة HTTP القياسية.

• 200 OK: معالجة ناجحة.
• 400 طلب سيئ: تنسيق حمولة غير صالح أو مفقود، أو عمق بيانات منظم يتجاوز 32 مستوى.
• 401 غير مصرح به: مفتاح API مفقود أو غير صالح أو غير نشط.
• 402 الدفع مطلوب: الاعتمادات المتبقية غير كافية. محظور عند حدود البوابة.
• 413 الحمولة كبيرة جدًا: يتجاوز نص الطلب 10 ميجابايت أو يتجاوز إجمالي عدد العناصر المنظمة 50000 مفتاح.
• 429 طلبات كثيرة جدًا: تم تجاوز حد المعدل (60 طلبًا/الدقيقة لكل مفتاح واجهة برمجة التطبيقات، و120 طلبًا/الدقيقة لكل حساب وIP). يشير رأس "إعادة المحاولة بعد" إلى وقت إعادة المحاولة.
• 502 بوابة سيئة: المحرك الأساسي غير قابل للوصول أو فشل في معالجة الواجهة الخلفية. يتم رد الاعتمادات تلقائيا.
• 504 Gateway Timeout: لم يستجب المحرك الأساسي خلال 30 ثانية. يتم رد الاعتمادات تلقائيا.

الكيانات المدعومة

• الشخص (الأسماء)
• المنظمة (أسماء الشركات)
• البريد الإلكتروني (عناوين البريد الإلكتروني)
• الهاتف (أرقام الهواتف)
• الموقع (المدن والعناوين)
• IP (IPv4 وIPv6)
• IBAN (الحسابات المصرفية)
• CARD (بطاقات الائتمان/الخصم)

الأمن

• تستبعد جداول فوترة البوابة ومقاييس الطلب المنظمة هيئات طلب واجهة برمجة التطبيقات والاستجابة. يتم الاحتفاظ بالبيانات الوصفية للحساب والمصادقة والاستخدام والحجز والدفع بشكل منفصل؛ لا يؤدي حذف الحساب إلى إزالة كل سجل أو نسخة احتياطية.
• يتم الاحتفاظ بالاستجابات الناجحة باستخدام Idempotency-Key في ذاكرة العملية لمدة نافذة إعادة تشغيل مدتها خمس دقائق. قد تحتوي تفاصيل الكيان على معرفات أصلية. تتطلب عناصر التحكم في المحرك والوكيل والمبادلة وتفريغ الأعطال والنسخ الاحتياطي تحققًا منفصلاً؛ لا يتم ضمان استمرارية القرص الصفرية عبر سلسلة المعالجة.
• راجع سياسة الخصوصية وصفحة الأمان للتعرف على حدود التعامل والحذف.