API குறிப்பு
டெவலப்பர்களுக்கான இடைமுகங்கள்: பொது இறுதிப்புள்ளிகள், அரட்டை விட்ஜெட், உள்நுழைவு, API விசையுடன் REST-API.
API குறிப்பு Zentor App-இன் இடைமுகங்களை விவரிக்கிறது, அவற்றை நீங்கள் உங்கள் சொந்த இணையதளங்கள் மற்றும் நிரல்களிலிருந்து அழைக்கலாம்: படிவங்கள், தயாரிப்பு உள்ளமைவி மற்றும் உள்ளடக்கத்திற்கான பொது இறுதிப்புள்ளிகள், அரட்டை விட்ஜெட், டெமோ சாட்பாட் மற்றும் ஒற்றை உள்நுழைவு உட்பட உள்நுழைவு. ஒவ்வொரு இறுதிப்புள்ளிப் பக்கமும் முறை, பாதை, அங்கீகாரம், அளவுருக்கள், கோரிக்கை மற்றும் பதிலுக்கான ஒரு எடுத்துக்காட்டு, ஆவணப்படுத்தப்பட்ட பிழைக் குறியீடுகளைக் குறிப்பிடுகிறது.
அங்கீகாரம்: படிவங்கள், தயாரிப்பு உள்ளமைவி, உள்ளடக்க இறுதிப்புள்ளிகள் உள்நுழைவு இன்றி அணுகக்கூடியவை. அரட்டை விட்ஜெட் இறுதிப்புள்ளிகள் `X-Widget-Token` தலைப்பில் உங்கள் விட்ஜெட்டின் உட்பொதிப்பு டோக்கனை எதிர்பார்க்கின்றன, விட்ஜெட்டிற்கு அனுமதிக்கப்பட்ட டொமைன்களிலிருந்து மட்டுமே அழைப்புகளை ஏற்கின்றன. உள்நுழைவு இறுதிப்புள்ளிகள் பயனர் அமர்வுகளுக்கு அணுகல் டோக்கன் (JWT) மற்றும் Refresh-Token ஐ வெளியிடுகின்றன.
API விசையுடன் API அணுகல்: உங்கள் சொந்த நிரல்கள் மற்றும் சர்வர்-க்கு-சர்வர் இணைப்புகளுக்கு, அடிப்படை URL `https://zentor-app.de/api/v1`-இல் REST-API கிடைக்கிறது. Zentor உங்கள் கணக்கிற்கு கோரிக்கையின் பேரில் API அணுகலைச் செயல்படுத்துகிறது. பின்னர் நிர்வாகிகள் டாஷ்போர்டில் "API விசைகள்" என்பதன் கீழ் தங்கள் சொந்த விசைகளை உருவாக்கி, அவற்றின் அனுமதிகளை (Scopes) நிர்ணயிக்கிறார்கள் - சந்திப்புகள் மற்றும் முன்பதிவுகள், சாட்பாட், தொடர்பு, கோப்புகள், அறிவுத் தளம், அறிக்கைகள், இணைய தரவுக்காக. ஒவ்வொரு பகுதிக்கும் ஒரு படிக்கும் அனுமதி (`<பகுதி>.read`, GET மட்டும்) மற்றும் ஒரு எழுதும் அனுமதி (`<பகுதி>.write`, படிப்பதையும் உள்ளடக்கியது) உள்ளது, எடுத்துக்காட்டாக `appointments.read` அல்லது `knowledge.write`. விசையை `Authorization: Bearer <API-விசை>` தலைப்பில் அல்லது மாற்றாக `X-API-Key` தலைப்பில் அனுப்பவும். `GET /api/v1/me` மூலம் ஒரு விசை எந்தக் கணக்கு, எந்த Scopes உடன் இணைக்கப்பட்டுள்ளது எனச் சரிபார்க்கலாம்.
முழு விசையும் உருவாக்கும்போது ஒரே ஒரு முறை மட்டுமே காட்டப்படும். அதைப் பாதுகாப்பாகவும் சர்வர் பக்கத்தில் மட்டும் வைத்திருங்கள், உலாவி குறியீடு அல்லது மொபைல் ஆப்களில் ஒருபோதும் வைக்காதீர்கள். விசைகளுக்கு காலாவதி தேதி இருக்கலாம், அவற்றைச் சுழற்றலாம், ரத்து செய்யலாம். REST-API மூலம் உங்கள் தொகுப்பில் அடங்கிய செயல்பாடுகள் மட்டுமே அணுகக்கூடியவை, அனைத்துத் தரவும் உங்கள் கணக்கிற்கு மட்டுப்படுத்தப்பட்டிருக்கும். பொதுவான பிழைகள்: 401 `API_KEY_INVALID`, `API_KEY_EXPIRED` அல்லது `API_KEY_REVOKED` (விசை இல்லை, தவறானது, காலாவதியானது அல்லது ரத்து செய்யப்பட்டது), 403 `API_ACCESS_NOT_ENABLED` (கணக்கிற்கு API அணுகல் செயல்படுத்தப்படவில்லை), 403 `API_SCOPE_MISSING` (விசைக்குத் தேவையான அனுமதி இல்லை), 403 `TENANT_NOT_ACTIVE` அல்லது `TENANT_LOCKED` (கணக்கு செயலிலில்லை அல்லது பூட்டப்பட்டுள்ளது), 404 `API_ENDPOINT_NOT_AVAILABLE` (இறுதிப்புள்ளி REST-API மூலம் கிடைக்கவில்லை).
பதில்கள் மற்றும் வரம்புகள்: அனைத்து இறுதிப்புள்ளிகளும் JSON உடன் பதிலளிக்கின்றன. வெற்றிகரமான பதிலில் 2xx நிலையும் `"ok": true`-ம் உள்ளன; பிழைப் பதிலில் இயந்திரம் படிக்கக்கூடிய பிழைக் குறியீடும் (`error` அல்லது `error.code` புலத்தில்) ஒரு செய்தியும் அடங்கும். ஒரு IP முகவரிக்கு 15 நிமிடங்களில் 2,000 கோரிக்கைகள் சாத்தியம்; படிவம், உறுதிப்படுத்தல், உள்நுழைவு இறுதிப்புள்ளிகளுக்கு, தொடர்புடைய பக்கத்தில் குறிப்பிடப்பட்டுள்ள கடுமையான வரம்புகள் பொருந்தும். மீறினால், சர்வர் 429 `RATE_LIMIT_EXCEEDED` உடன் பதிலளிக்கும். idempotent அல்ல என குறிக்கப்பட்ட இறுதிப்புள்ளிகள் இணைப்பு துண்டிக்கப்பட்ட பிறகு தானாக மீண்டும் செய்யப்படக் கூடாது, ஏனெனில் இது நகல் கோரிக்கைகள் அல்லது செய்திகளை உருவாக்கலாம்.
கடவுச்சொற்கள், டோக்கன்கள், API விசைகள் மற்றும் உறுதிப்படுத்தல் குறியீடுகளை கோரிக்கை உள்ளடக்கத்தில் அல்லது தலைப்புகளில் HTTPS மூலம் மட்டுமே அனுப்பவும் - URL-கள், பதிவுகள் அல்லது ஆதரவுக் கோரிக்கைகளில் அல்ல.