छद्म नाम.आईओ एपीआई

Pseudonymize.io दस्तावेज़ में आपका स्वागत है। बाहरी सिस्टम (जैसे एलएलएम, एनालिटिक्स वेयरहाउस, या थर्ड-पार्टी सपोर्ट टूल) तक पहुंचने से पहले इस एपीआई को अपने संवेदनशील डेटा के पथ में रखें।

त्वरित शुरुआत

गद्य को छद्म नाम देने के लिए टेक्स्ट एपीआई को एक अनुरोध भेजें।

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" }
  ]
}

प्रमाणीकरण

सभी एपीआई अनुरोधों में प्राधिकरण शीर्षलेख में आपकी एपीआई कुंजी शामिल होनी चाहिए।

Authorization: Bearer ps_live_...

एपीआई कुंजियाँ ps_live_... प्रारूप में उत्पन्न होती हैं। आपकी सुरक्षा के लिए, संपूर्ण गुप्त कुंजी निर्माण के समय केवल एक बार प्रदर्शित की जाती है। छद्मनामाइज़.आईओ कभी भी एपीआई कुंजियों को सादे टेक्स्ट में संग्रहीत नहीं करता है - केवल एक गैर-प्रतिवर्ती क्रिप्टोग्राफ़िक हैश (SHA-256) और एक संक्षिप्त पहचान उपसर्ग (ps_live_XXXX) कायम रहता है।

आप अपनी एपीआई कुंजियाँ डैशबोर्ड में प्रबंधित कर सकते हैं।

टेक्स्ट एपीआई

पोस्ट https://api.pseudonymize.io/text (POST https://api.pseudonymize.io/v1/text और /api/v1/text के माध्यम से भी उपलब्ध)

गद्य के अंदर पहचानकर्ताओं को उनके चारों ओर पाठ को समतल किए बिना प्रतिस्थापित करता है।

अनुरोध निकाय

• टेक्स्ट (स्ट्रिंग, आवश्यक): संसाधित होने वाला टेक्स्ट।
• नीति (स्ट्रिंग, वैकल्पिक): उपयोग की जाने वाली नीति। डिफ़ॉल्ट ``डिफ़ॉल्ट'' पर।
• पता लगाएं (सरणी, वैकल्पिक): पता लगाने के लिए विशिष्ट इकाई प्रकार।

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

संरचित डेटा एपीआई

पोस्ट /एपीआई/वी1/डेटा

पंक्तियों और स्कीमा को प्रयोग योग्य रखते हुए पहचानकर्ता फ़ील्ड को छद्म नाम दें।

अनुरोध निकाय

• पेलोड (ऑब्जेक्ट | सरणी, आवश्यक): संसाधित करने के लिए JSON संरचना (डेटा के रूप में भी पारित किया जा सकता है)।
• नीति (स्ट्रिंग, वैकल्पिक): उपयोग की जाने वाली नीति। डिफ़ॉल्ट ``डिफ़ॉल्ट'' पर।
• पता लगाएं (सरणी, वैकल्पिक): पता लगाने के लिए विशिष्ट इकाई प्रकार।

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

बिलिंग एवं क्रेडिट आरक्षण

Pseudonymize.io एक पारदर्शी पे-एज़-यू-गो मॉडल पर काम करता है:

• प्रति दस लाख मापे गए टोकन €1। हर सफल अनुरोध को 1,000 टोकन (1 क्रेडिट) के अगले गुणज तक पूर्णांकित किया जाता है; न्यूनतम शुल्क €0.001 है।
• उड़ान-पूर्व आरक्षण: पेलोड के कोर इंजन तक पहुंचने से पहले गेटवे सीमा पर क्रेडिट परमाणु रूप से आरक्षित होते हैं। यदि किसी खाते में अपर्याप्त क्रेडिट है, तो एपीआई ग्राहक डेटा अग्रेषित किए बिना तुरंत 402 भुगतान आवश्यक लौटाता है।
• स्वचालित रिफंड गारंटी: यदि अपस्ट्रीम कोर प्रोसेसिंग कॉल विफल हो जाती है या समय समाप्त हो जाती है, तो आरक्षित क्रेडिट तुरंत पूर्ण रूप से वापस कर दिए जाते हैं।

छद्मनाम और नियतिवादी पहचान

Pseudonymize.io एक ही अनुरोध में नियतात्मक पहचान संरक्षण का उपयोग करता है। यदि "ऐलिस" एक ही दस्तावेज़ में तीन बार दिखाई देती है, तो वह तीनों बार PERSON_01 बन जाती है। यह एलएलएम को यह समझने की अनुमति देता है कि यह वही व्यक्ति है, बिना यह जाने कि यह कौन है।

त्रुटियाँ और सीमाएँ

हम मानक HTTP स्थिति कोड का उपयोग करते हैं।

• 200 ओके: सफल प्रसंस्करण।
• 400 ख़राब अनुरोध: अमान्य या अनुपलब्ध पेलोड प्रारूप, या 32 स्तरों से अधिक संरचित डेटा गहराई।
• 401 अनधिकृत: गुम, अमान्य, या निष्क्रिय एपीआई कुंजी।
• 402 भुगतान आवश्यक: अपर्याप्त क्रेडिट शेष। प्रवेश द्वार सीमा पर अवरोधित.
• 413 पेलोड बहुत बड़ा: अनुरोध का मुख्य भाग 10एमबी से अधिक है या कुल संरचित तत्व संख्या 50,000 कुंजियों से अधिक है।
• 429 बहुत अधिक अनुरोध: दर सीमा पार हो गई (60 अनुरोध/मिनट प्रति एपीआई कुंजी, 120 अनुरोध/मिनट प्रति खाता और आईपी)। 'पुनर्प्रयास-आफ्टर' हेडर इंगित करता है कि कब पुनः प्रयास करना है।
• 502 ख़राब गेटवे: कोर इंजन पहुंच योग्य नहीं है या बैकएंड प्रोसेसिंग विफलता। क्रेडिट स्वचालित रूप से वापस कर दिए जाते हैं.
• 504 गेटवे टाइमआउट: कोर इंजन ने 30 सेकंड के भीतर प्रतिक्रिया नहीं दी। क्रेडिट स्वचालित रूप से वापस कर दिए जाते हैं.

समर्थित संस्थाएँ

• व्यक्ति (नाम)
• संगठन (कंपनी के नाम)
• ईमेल (ईमेल पते)
• फ़ोन (फ़ोन नंबर)
• स्थान (शहर, पते)
• आईपी (आईपीवी4 और आईपीवी6)
• आईबीएएन (बैंक खाते)
• कार्ड (क्रेडिट/डेबिट कार्ड)

सुरक्षा

• गेटवे बिलिंग टेबल और संरचित अनुरोध मेट्रिक्स एपीआई अनुरोध और प्रतिक्रिया निकायों को बाहर करते हैं। खाता, प्रमाणीकरण, उपयोग, आरक्षण और भुगतान मेटाडेटा अलग से बनाए रखा जाता है; खाता हटाने से प्रत्येक रिकॉर्ड या बैकअप शुद्ध नहीं होता है।
• Idempotency-Key के साथ सफल प्रतिक्रियाओं को पांच मिनट की रीप्ले विंडो के लिए प्रोसेस मेमोरी में रखा जाता है। इकाई विवरण में मूल पहचानकर्ता शामिल हो सकते हैं। इंजन, प्रॉक्सी, स्वैप, क्रैश-डंप और बैकअप नियंत्रण के लिए अलग-अलग सत्यापन की आवश्यकता होती है; प्रसंस्करण श्रृंखला में शून्य डिस्क दृढ़ता की गारंटी नहीं है।
• सीमाओं को संभालने और हटाने के लिए गोपनीयता नीति और सुरक्षा पृष्ठ देखें।