API குறிப்பு
டெவலப்பர்களுக்கான பொது API முனைப்புள்ளிகள்: படிவங்கள், Widget, தயாரிப்பு உள்ளமைவி மற்றும் பல.
இந்தக் குறிப்பு உண்மையான, பொதுவில் பயன்படுத்தக்கூடிய JSON முனையங்களை மட்டுமே விவரிக்கிறது -- ஒவ்வொரு முனையத்திற்கும் முறை, பாதை, அங்கீகார வகை, கட்டாய அளவுருக்கள், எடுத்துக்காட்டுக் கோரிக்கை மற்றும் பதில், ஆவணப்படுத்தப்பட்ட பிழைக் குறியீடுகள். Zentor இல் பொதுவான டெவலப்பர் API விசை அமைப்பு இல்லை; வழித்தடத்தைப் பொறுத்து அணுகல் அங்கீகாரம் இல்லாமலோ அல்லது Origin சரிபார்ப்புடன் கூடிய Widget-Embed-Token மூலமோ நடைபெறுகிறது. உள் டாஷ்போர்டு வழித்தடங்களும் Master-Admin முனையங்களும் வழக்கமான உள்நுழைவு அமர்வின் மூலம் மட்டுமே அணுகக்கூடியவை என்பதால், அவை வேண்டுமென்றே இந்தப் பொதுக் குறிப்பில் சேர்க்கப்படவில்லை.
ஒவ்வொரு முனைய உள்ளீடும் ஒரு நேரலைச் சோதனைக் குறிப்பைக் கொண்டுள்ளது; அந்தத் தகவல் Registry திட்டத்திலிருந்தா, தானியங்கிச் சோதனையிலிருந்தா அல்லது உண்மையான நேரலைக் கண்காணிப்பிலிருந்தா வந்தது என்பதை அது வெளிப்படுத்துகிறது -- செயல்படும் குறியீட்டுப் பாதையுடனான வெறும் ஒற்றுமை முழுமையான சான்றாகக் கருதப்படாது. மேலும், தொழில்நுட்ப ரீதியாக வெற்றிகரமான அழைப்பு எப்போதும் அந்தந்தக் கோரிக்கையின் செயலாக்கத்தை மட்டுமே உறுதிப்படுத்துகிறது; மின்னஞ்சல் விநியோகம், கட்டண நிறைவு அல்லது முடிந்த SSO உள்நுழைவு போன்ற பிந்தைய செயல்முறைகளைத் தானாக உறுதிப்படுத்துவதில்லை.
பாதுகாப்பு அந்தந்தக் குழுவைப் பொறுத்தது. பொதுச் சட்ட, சந்தைப்படுத்தல் மற்றும் படிவ முனையங்களுக்கு டாஷ்போர்டு அமர்வு தேவையில்லை. மாறாக, அரட்டை Widget, Header `X-Widget-Token` ஐயும் Origin-Allowlist ஐயும் பயன்படுத்துகிறது. டாஷ்போர்டு உள்நுழைவுகள் பன்னிரண்டு மணிநேரச் செல்லுபடிக் காலம் கொண்ட Session-JWT ஐயும் ஏழு நாட்கள் செல்லுபடியாகும் Refresh-Token ஐயும் வழங்குகின்றன. SSO முனையங்கள் தனிப்பட்ட ஒருமுறைக் குறியீடுகள் மற்றும் Callback செயல்முறைகளுடன் செயல்படுகின்றன.
ஒவ்வொரு முனையப் பக்கத்தையும் ஒரு தனி ஒப்பந்தமாகப் படியுங்கள். HTTP முறை, பாதை, கட்டாய அளவுருக்கள், தரவு வகைகள், Request-Body, Response கட்டமைப்பு, பிழைக் குறியீடுகள் மற்றும் Idempotency ஆகியவையே தீர்மானகரமானவை. ஒரு எடுத்துக்காட்டு சாத்தியமான வடிவத்தைக் காட்டுகிறது, ஆனால் உண்மையான பதிலைச் சரிபார்ப்பதற்கு மாற்றாகாது. உள்ளமைவு நிலை, சரிபார்ப்புகள், அனுமதிகள் மற்றும் வெளிப்புற வழங்குநர்கள் முடிவை மாற்றக்கூடும்.
உறுதிப்படுத்தப்பட்ட தளம் தழுவிய Rate-Limit 15 நிமிடங்களுக்குள் 2.000 Requests ஆகும். முனையம் வாரியான தனி வரம்புகள் எல்லா இடங்களிலும் ஆவணப்படுத்தப்படவில்லை. எனவே Clients தேவையற்ற நெருக்கமான Polling சுழற்சிகளைப் பயன்படுத்தக் கூடாது. Idempotent அல்லாத செயல்பாடுகளில், தானியங்கி மறுமுயற்சிகள் நகல் தரவுப் பதிவுகளையோ செய்திகளையோ உருவாக்கக்கூடும்.
முக்கியமான மதிப்புகள் பதிவுகளில் இடம்பெறக் கூடாது. இவற்றில் கடவுச்சொற்கள், Reset டோக்கன்கள், சரிபார்ப்புக் குறியீடுகள், Widget டோக்கன்கள், Session ID கள் மற்றும் உண்மையான தனிப்பட்ட எடுத்துக்காட்டுத் தரவுகள் அடங்கும். ஆவணங்களிலும் சோதனைகளிலும் அநாமதேயமாக்கப்பட்ட மதிப்புகளைப் பயன்படுத்துங்கள். நேரலைச் சோதனைக் குறிப்புகள் உண்மையான சான்றைச் சரியாகப் பிரதிபலிக்க வேண்டும்.