Optifora API எவ்வாறு செயல்படுகிறது
இந்தப் பக்கம் API இன் அமைப்பை விவரிக்கிறது: அடையாளம் எப்படி நிரூபிக்கப்படுகிறது, பதிப்புகள் எப்படி முன்னேறுகின்றன, ஒரு கோரிக்கை எந்த வரம்புகளுக்குள் இருக்க வேண்டும், பிழை எப்படித் தோன்றும், வெளி உலகுடன் தரவு எப்படிப் பரிமாறப்படுகிறது.
இந்தத் தயாரிப்பு உருவாக்கத்தில் உள்ளது; API பரப்பு இன்னும் நிறைவடைந்து வருகிறது. முனைகளுக்கான குறிப்பு ஆவணம் தனியாக வெளியிடப்படும்; இந்தப் பக்கம் எந்த முகவரியையும் மாதிரி அழைப்பையும் சுமக்கவில்லை, இயங்கு முறையை மட்டுமே சொல்கிறது.
அடையாள உறுதிப்படுத்தல்
ஒவ்வொரு கோரிக்கையும் ஒரு நபருக்கோ அல்லது பதிவு செய்யப்பட்ட ஒரு பயன்பாட்டுக்கோ சொந்தமானது. அடையாளம் இல்லாத ஒரு கோரிக்கை பாதுகாக்கப்பட்ட முனையை அடைந்தால், அது அடையாளம் உறுதிப்படுத்தப்படாதது எனத் திருப்பி அனுப்பப்படுகிறது.
- Bearer டோக்கன்அணுகல் டோக்கன் கோரிக்கையின் அங்கீகாரத் தலைப்பில் பயணிக்கிறது. அது கையொப்பமிடப்பட்டது; கோரிக்கை யாருக்குச் சொந்தம் என்பதை மட்டுமே சொல்கிறது.
- குறுகிய ஆயுள்அணுகல் டோக்கனின் ஆயுள் நிமிடங்களால் அளக்கப்படுகிறது; அந்தக் கால அளவு நிறுவல் அமைப்பாகும், இயல்பாக 30 நிமிடங்கள்.
- புதுப்பித்தலும் சுழற்சியும்அமர்வு புதுப்பிப்பு டோக்கனால் நீட்டிக்கப்படுகிறது; ஒவ்வொரு நீட்டிப்பும் புதிய இணையை வழங்குகிறது. பயன்படுத்தி முடிந்த புதுப்பிப்பு டோக்கன் இரண்டாம் முறை காட்டப்பட்டால், அந்த நபரின் அனைத்து அமர்வுகளும் ரத்து செய்யப்படுகின்றன.
- அனுமதிகள் டோக்கனுக்குள் பதிக்கப்படுவதில்லைடோக்கன் அடையாளத்தை மட்டுமே சுமக்கிறது; ஒரு நபர் எதைப் பார்க்கலாம் என்பது ஒவ்வொரு கோரிக்கையிலும் தரவுத்தளத்திடம் கேட்கப்படுகிறது. எனவே திரும்பப் பெறப்பட்ட ஓர் அனுமதி, கையிலுள்ள டோக்கனின் ஆயுள் முடிவதற்கு முன்பே செயலிழக்கிறது.
- ஒருங்கிணைப்பாளர் சாவிபதிவு செய்யப்பட்ட ஒவ்வொரு பயன்பாடும் தனக்கே உரிய சாவியுடன் இணைகிறது. சாவியின் வெளிப்படையான மதிப்பு உருவாக்கும் தருணத்தில் ஒரே ஒரு முறை காட்டப்படுகிறது; சேமிக்கப்படுவது அதன் சுருக்கக் குறியீடும், சாவியை அடையாளம் காண உதவும் இரகசியமற்ற முன்னொட்டும் மட்டுமே.
- அணுகலை வழங்குவது நிறுவனம்ஒரு பயன்பாடு எவ்வளவு பரவலாகப் பயன்படுத்தப்பட்டாலும், நிறுவனம் பதிவு செய்த அனுமதி இல்லாமல் அது ஒரு வரியைக்கூடப் பார்க்க முடியாது. அந்த அனுமதி தேதியிடப்பட்டது, எல்லை வரையறுக்கப்பட்டது, திரும்பப் பெறக்கூடியது.
பதிப்பு முறை
- பதிப்பு பாதையில் இருக்கிறதுமுனைகள் ஒரு பதிப்பு முன்னொட்டுக்குப் பின் வெளியிடப்படுகின்றன; இன்றைய பரப்பு பதிப்பு 1.
- உடைக்கும் மாற்றம் புதிய பாதையைத் திறக்கிறதுஇருக்கும் ஒரு முனையின் ஒப்பந்தம் இருந்த இடத்திலேயே உடைக்கப்படுவதில்லை. பொருந்தாத மாற்றம் புதிய பதிப்புப் பாதையில் வெளியிடப்படுகிறது; பழையது தொடர்ந்து இயங்குகிறது.
- ஆவணம் தன் பதிப்பைத் தானே அறிவிக்கிறதுகுறிப்பு ஆவணம், எந்தப் பதிப்பிலிருந்து உருவாக்கப்பட்டதோ அந்த எண்ணைச் சுமக்கிறது; நீங்கள் எந்தப் பதிப்பைப் படிக்கிறீர்கள் என்பதற்கு ஆவணமே பதில் சொல்கிறது.
சூழல்களும் வரம்புகளும்
குறிப்பு ஆவணம் இரண்டு சூழல்களை அறிவிக்கிறது: நடைமுறைச் சூழல் மற்றும் உள்ளக உருவாக்கச் சூழல். வேர் முகவரி ஒருங்கிணைப்பாளருக்கு அவரது சாவியுடன் சேர்த்து வழங்கப்படுகிறது; இந்தப் பக்கத்தில் அது வெளியிடப்படவில்லை.
- இயங்குநிலையும் தயார்நிலையும் தனித்தனியாக அளக்கப்படுகின்றனஒரு முனை செயல்முறை இயங்குகிறதா என்று சொல்கிறது; இரண்டாவது முனை தரவுத்தளத்திற்கு உண்மையான வினவலை அனுப்பி அது எட்டக்கூடியது என உறுதி செய்கிறது. போக்குவரத்து அனுப்பப்பட வேண்டுமா என்பதை இரண்டாவது மட்டுமே தீர்மானிக்கிறது.
- உலாவி மூலங்கள் ஒரு பட்டியலுக்குள் வரம்பிடப்பட்டுள்ளனவேறு மூலத்திலிருந்து வரும் கோரிக்கைகள், முன்கூட்டியே அறிவிக்கப்பட்ட மூலங்களிலிருந்து மட்டுமே ஏற்கப்படுகின்றன; பட்டியல் காலியாக இருக்கும் வரை உலாவியிலிருந்து வரும் வேற்று-மூலக் கோரிக்கை மறுக்கப்படுகிறது.
- உள்ளடக்க அளவு வரம்புகோரிக்கையின் உள்ளடக்கம் 5 மெகாபைட்டைத் தாண்ட முடியாது. பெரிய தொகுப்புகள் ஒற்றைக் கோரிக்கையாக அல்ல, தனி நிலைப் பதிவுடன் கூடிய மொத்தப் பரிமாற்றப் பணியாகப் பயணிக்கின்றன.
- இரகசியங்கள் பதிவேட்டில் எழுதப்படுவதில்லைசேவையகப் பதிவேடு அங்கீகாரத் தலைப்பையோ, குக்கீயையோ, கடவுச்சொல்லையோ, தேசிய அடையாள எண்ணையோ சேமிப்பதில்லை.
வேக வரம்பு
வரம்பு ஒவ்வொரு முகவரிக்கும், ஒவ்வொரு நிமிடத்திற்கும் தனித்தனியாகப் பொருந்தும். இயல்பு மதிப்பு நிமிடத்திற்கு 120 கோரிக்கைகள்; இது நிறுவலின்போது அமைக்கப்படுகிறது. மீதமுள்ளது ஒவ்வொரு பதிலின் தலைப்புகளிலும் தெரிவிக்கப்படுகிறது.
| பதில் தலைப்பு | என்ன சொல்கிறது |
|---|---|
| x-ratelimit-limit | கால அளவுக்குள் அனுமதிக்கப்படும் மொத்த எண்ணிக்கை. |
| x-ratelimit-remaining | இந்தக் கால அளவில் மீதமுள்ளது எவ்வளவு. |
| x-ratelimit-reset | அனுமதி புதுப்பிக்கப்படும் வரையிலான வினாடிகள். |
| retry-after | மறுமுயற்சிக்கு முன் எத்தனை வினாடிகள். கோரிக்கையை மறுத்த பதிலில் மட்டுமே இது இருக்கும். |
வரம்பு தாண்டியவுடன் கோரிக்கை மறுக்கப்படுகிறது; எத்தனை வினாடிகள் காத்திருக்க வேண்டும் என்பதைப் பதில் தெரிவிக்கிறது. மறுமுயற்சி உடனடியாக அல்ல, அந்த நேரம் கழித்தே செய்யப்படுகிறது.
பிழை வடிவம்
ஒவ்வொரு பிழையும் ஒரே உறையில் திரும்பி வருகிறது: இயந்திரம் முடிவெடுக்கக் குறுகிய குறியீட்டுப் புலம், மனிதர் படிக்க ஒரு விளக்கப் புலம்.
- errorகிளையண்ட் முடிவெடுக்கப் பயன்படுத்தும் குறுகிய குறியீடு.
- messageஎன்ன நடந்தது என்பதன் விளக்கம்.
| நிலைக் குறியீடு | குறியீட்டுப் புலம் | பொருள் என்ன |
|---|---|---|
| 400 | Bad Request | கோரிக்கை திட்டவரைவுடன் பொருந்தவில்லை. விடுபட்ட அல்லது தவறான புலத்தின் பெயரை விளக்கம் சொல்கிறது. |
| 401 | unauthenticated | செல்லுபடியான அடையாளம் இல்லை: டோக்கன் அனுப்பப்படவில்லை, அதன் ஆயுள் முடிந்துவிட்டது, அல்லது சரிபார்ப்பில் தேறவில்லை. |
| 404 | Not Found | அத்தகைய முனை இல்லை, அல்லது அத்தகைய பதிவு இல்லை. |
| 429 | Too Many Requests | வேக வரம்பு மீறப்பட்டது; எவ்வளவு நேரம் காத்திருக்க வேண்டும் என்பதைப் பதில் சொல்கிறது. |
| 5xx | internal_error | எதிர்பாராத ஒரு செயலிழப்பு. விவரம் கிளையண்டிடம் தரப்படுவதில்லை; அது சேவையகப் பதிவேட்டில் எழுதப்படுகிறது. |
பக்கப் பிரிப்பு
பட்டியல்களைத் திருப்பும் முனைகள் ஒரே இரண்டு அளவுருக்களை ஏற்று ஒரே கணக்கீடுகளைத் திருப்புகின்றன; எனவே பக்கம் பிரிக்கும் கிளையண்டை ஒவ்வொரு முனைக்கும் மீண்டும் எழுத வேண்டியதில்லை.
- limitஒரு பக்கத்தில் எத்தனை பதிவுகள் இருக்க வேண்டும். குறைந்தது 1, அதிகபட்சம் 200; அமைக்கப்படாதபோது 50.
- offsetஎத்தனை பதிவுகளைத் தவிர்க்க வேண்டும். 0 இலிருந்து தொடங்குகிறது.
- totalவடிகட்டிகளுக்குப் பொருந்தும் மொத்தப் பதிவுகள் எத்தனை.
- countஇந்தப் பதில் உண்மையில் எத்தனை பதிவுகளைச் சுமக்கிறது.
பயன்படுத்திய limit மற்றும் offset மதிப்புகளைப் பதிலும் திருப்பிச் சொல்கிறது; கிளையண்ட் தன் இடத்தை ஊகிக்காமல் பதிலிலிருந்தே படிக்கிறது.
தரவுப் பரிமாற்றமும் வெப்ஹூக்குகளும்
பரிமாற்ற முறை என்பது தனித் தயாரிப்பு அல்ல, ஓர் அமைப்பு: பதிவு செய்யப்பட்ட ஒவ்வொரு பயன்பாடும் தான் இயங்கும் முறையைத் தன் பதிவிலேயே சுமக்கிறது.
| முறை | பொருள் என்ன |
|---|---|
| ஒருவழி — வெளிநோக்கி | Optifora தரவை வெளியிடுகிறது; மறுதரப்பு அதைப் படிக்கிறது அல்லது நிகழ்வுகளுக்குச் சந்தா செய்கிறது. |
| ஒருவழி — உள்நோக்கி | மறுதரப்பு தரவைத் தள்ளுகிறது; Optifora அதைச் சரிபார்த்து எழுதுகிறது. |
| இருவழி | இரு தரப்பும் எழுதுகின்றன; முரண்பாடு ஏற்பட்டால் பின்பற்ற வேண்டிய விதி முன்கூட்டியே வரையறுக்கப்படுகிறது. |
| கைகுலுக்கல் | ஒவ்வொரு பரிமாற்றமும் ஓர் அமர்வைத் திறக்கிறது: முன்மொழிவு, சரிபார்ப்பு, ஒப்புதல், பரிமாற்றம், ரசீது. ரசீது இரு தரப்பிலும் நிலைத்திருக்கிறது. |
- நிகழ்வுகள் வெளியே தள்ளப்படுகின்றனவெப்ஹூக், பதிவு செய்யப்பட்ட பயன்பாடு அறிவித்த பின்னழைப்பு முகவரிக்கு நிகழ்வை அனுப்புகிறது. வழங்க முடியாத நிகழ்வு வரிசையில் காத்திருந்து மீண்டும் முயற்சிக்கப்படுகிறது; அது ஒருபோதும் மௌனமாகக் கைவிடப்படுவதில்லை.
- ஒரே கோரிக்கை இருமுறை எழுதுவதில்லைஎழுதும் கோரிக்கை ஒரு மீள்நிகழ்வுத் தடுப்புச் சாவியைச் (idempotency key) சுமக்கிறது. அதே சாவியுடன் வரும் இரண்டாவது கோரிக்கை இரண்டாவது பதிவை உருவாக்குவதில்லை.
- ஒவ்வொரு அழைப்பும் அளக்கப்படுகிறதுயார் அழைத்தார், எப்போது, எந்த எல்லையுடன், என்ன முடிவுடன் — அனைத்தும் பதிவு செய்யப்படுகிறது. பிழைத் திருத்தத்திற்கும், இந்தத் தரவை யார் இழுத்தார் என்ற கேள்விக்கும் அதே பதிவே பதில் சொல்கிறது.
- எங்கள் பயன்பாடுகளும் அதே கதவையே பயன்படுத்துகின்றனசலுகை பெற்ற இரண்டாவது பாதை எதுவும் இல்லை. வெளி உருவாக்குநர் சந்திக்கும் பரப்புக்கு எங்கள் சொந்த ஒருங்கிணைப்பே சான்று.
பரிமாற்ற அடுக்கின் தரவு மாதிரி தயாராக உள்ளது; அதன் முனைகள் இன்னும் வெளியிடப்படவில்லை. வெளியிடப்பட்டதும், குறிப்பு ஆவணத்தில் உள்ள அவற்றின் பதிவுகளுக்கு இந்தப் பிரிவு இணைப்புத் தரும்.
குறிப்பு ஆவணங்கள்
குறிப்பு ஆவணம் கையால் எழுதப்படுவதில்லை; அது முனைகளின் திட்டவரைவுகளிலிருந்து உருவாக்கப்படுகிறது. ஒவ்வொரு முனையும் தன் திட்டவரைவை ஒப்படைக்கும்போது ஆவணம் தானாக நிரம்புகிறது; எனவே ஆவணமும் நடத்தையும் ஒன்றுக்கொன்று விலக முடியாது.
- இன்று: தயாரிப்பில்திட்டவரைவுகள் தொகுதி தொகுதியாக நகர்கின்றன. ஆவணம் வெளியிடப்படுவதற்கு முன், ஒவ்வொரு முனையின் கோரிக்கையும் பதிலும் அதில் தெரியும்.
- இரு வடிவங்களில் வெளியிடப்படும்இயந்திரம் படிக்கக்கூடிய ஓர் OpenAPI ஆவணம், மேலும் அதே ஆவணத்திலிருந்து உருவாக்கப்பட்டு உலாவியில் பார்வையிடக்கூடிய ஒரு குறிப்புப் பக்கம்.
- அணுகல் படிநிலையானதுபொதுப் பார்வை அனைவருக்கும் திறந்தது. முழுக் குறிப்பு ஆவணம், பதிவு செய்யப்பட்ட ஒருங்கிணைப்பாளருக்கு வழங்கப்படும் ஆவண டோக்கனுக்குப் பின் இருக்கலாம்; நடைமுறைச் சாவிகளும் பின்னழைப்பு முகவரிகளும் ஆவணத்தின் விஷயமே அல்ல — அவை பயன்பாட்டுப் பதிவுக்கு உரியவை.
- முகவரித் தரநிலைஇரண்டு குறிப்பு ஆவணங்கள் வெளியிடப்படும், அவற்றின் முகவரிகள் நிலையானவை: client-api.optifora.com/docs அனைவருக்கும் திறந்தது, admin-api.optifora.com/docs அங்கீகாரம் கேட்கிறது, வெளியுலகுக்கு மூடப்பட்டது. இன்று இரண்டும் இயங்கவில்லை; இயங்கத் தொடங்கியதும் இணைப்புகள் இந்தப் பிரிவில் சேர்க்கப்படும்.
உங்கள் ஒருங்கிணைப்புத் திட்டம் ஏற்கெனவே தெளிவாக இருந்தால், தொடர்புப் பக்கத்திலிருந்து எங்களுக்கு எழுதுங்கள்: பரப்பு திறக்கும்போது முதலில் அறிவிக்கப்படுபவர்களில் நீங்களும் இருப்பீர்கள்.
குறிப்பிட்ட கோரிக்கை ஏதும் உள்ளதா?
ஆதரவுச் செயல்முறை எப்படி இயங்குகிறது என்பதை இந்தப் பக்கங்கள் விளக்குகின்றன. உங்களுக்குக் கோரிக்கையோ கேள்வியோ இருந்தால், தொடர்புப் பக்கத்திலிருந்து எங்களுக்கு எழுதுங்கள்.
தொடர்புப் பக்கத்திற்குச் செல்லுங்கள்