SDK ಮತ್ತು API ಕ್ಲೈಂಟ್ಗಳು
HTTP ಕ್ಲೈಂಟ್ ಮೂಲಕ Oblic API ಅನ್ನು ಕರೆ ಮಾಡಿ. API ಯಲ್ಲಿ HTTPS ಮತ್ತು JSON ಬಳಸಲಾಗುತ್ತದೆ; ಪ್ರತಿ ಆವೃತ್ತಿಯ OpenAPI ದಾಖಲೆಯಿಂದ ಜನರೇಟರ್ ನಿಮ್ಮ ಭಾಷೆಯಲ್ಲಿ ಟೈಪ್ಗಳಿರುವ ಕ್ಲೈಂಟ್ ರಚಿಸಬಹುದು.
OpenAPI ದಾಖಲೆಗಳು
| ಆವೃತ್ತಿ | ದಾಖಲೆ | ದೃಢೀಕರಣ ವಿಧಾನ |
|---|---|---|
| v1 | external-v1.json | API ಕೀ (ದೃಢೀಕರಣ) |
| v2 | external-v2.json | OAuth ಪ್ರವೇಶ ಟೋಕನ್ (API v2) |
- ಪ್ರತಿ ಕಾರ್ಯಾಚರಣೆಗೆ ಹೆಸರಿರುತ್ತದೆ (
operationId), ಉದಾಹರಣೆಗೆsendEmailಅಥವಾlistMessages; ಜನರೇಟರ್ ಅದನ್ನು ಮೆಥಡ್ ಆಗಿ ಪರಿವರ್ತಿಸುತ್ತದೆ. - ಕೀಗೆ ಬೇಕಾದ ಅನುಮತಿಗಳನ್ನು v1 ದಾಖಲೆ ತಿಳಿಸುತ್ತದೆ: ಪ್ರತಿ ಕಾರ್ಯಾಚರಣೆಯ
x-oblic-scopesಪಟ್ಟಿಯಲ್ಲಿರುವ ಕನಿಷ್ಠ ಒಂದು ವ್ಯಾಪ್ತಿ ಕೀಯಲ್ಲಿ ಇರಬೇಕು;x-oblic-key-rolesಅದನ್ನು ಕರೆ ಮಾಡಬಹುದಾದ ಕೀ ಪಾತ್ರಗಳನ್ನು ಪಟ್ಟಿ ಮಾಡುತ್ತದೆ. - v1 ದಾಖಲೆ ಪ್ರತಿ ನಿರಾಕರಣೆಯನ್ನು ಒಂದೇ ಬಾರಿ ವಿವರಿಸುತ್ತದೆ, ಪ್ರತಿ ಕಾರ್ಯಾಚರಣೆಯ
defaultಪ್ರತಿಕ್ರಿಯೆಯಾಗಿ:statusಅನ್ನುerrorಎಂದು ಹೊಂದಿಸಿರುವ ಎನ್ವೆಲಪ್ ಮತ್ತು ಅದರ ದೋಷಗಳು.
ಕ್ಲೈಂಟ್ ರಚಿಸುವುದು
ಹೆಚ್ಚಿನ ಜನರೇಟರ್ಗಳು OpenAPI 3.1 ದಾಖಲೆಗಳನ್ನು ಓದುತ್ತವೆ. Java ಅಗತ್ಯವಿರುವ OpenAPI Generator ಬಳಸಿ:
v1 ಗಾಗಿ TypeScript ಕ್ಲೈಂಟ್
npx @openapitools/openapi-generator-cli generate \
-i https://docs.oblic.app/openapi/external-v1.json \
-g typescript-fetch \
-o ./oblic-client
-g python, -g go, -g java ಅಥವಾ -g php ನೀಡಿದರೆ ಆ ಭಾಷೆಯಲ್ಲಿ ಕ್ಲೈಂಟ್ ರಚಿಸಲಾಗುತ್ತದೆ. ರಚಿಸಿದ ಕ್ಲೈಂಟ್ನ ಕಳುಹಿಸುವ ವಿನಂತಿಗಳನ್ನು ಪರಿಶೀಲಿಸಿ: ಜನರೇಟರ್ ಸ್ವತಃ Idempotency-Key ಸೇರಿಸುವುದಿಲ್ಲ; ಆದ್ದರಿಂದ ಮರುಪ್ರಯತ್ನಿಸಬಹುದಾದ ಪ್ರತಿ ಕಳುಹಿಸುವಿಕೆಯೊಂದಿಗೆ ಅದನ್ನು ನೀಡಿ.
ಕ್ಲೈಂಟ್ ಬಳಸುವುದು
- ಕೀಯನ್ನು ನಿಮ್ಮ ಸರ್ವರ್ಗಳಲ್ಲೇ ಇರಿಸಿ. ಸೀಕ್ರೆಟ್ ಸ್ಟೋರ್ ಅಥವಾ ಸುರಕ್ಷಿತ ಎನ್ವಿರಾನ್ಮೆಂಟ್ ವೇರಿಯಬಲ್ನಿಂದ ಅದನ್ನು ಲೋಡ್ ಮಾಡಿ; ಬ್ರೌಸರ್ ಅಥವಾ ಆ್ಯಪ್ ಡೌನ್ಲೋಡ್ ಮಾಡುವ ಕೋಡ್ನಿಂದ ಎಂದಿಗೂ ಅಲ್ಲ.
- ಅದೇ
Idempotency-Keyಬಳಸಿ ಮರುಪ್ರಯತ್ನಿಸಿ, ಮತ್ತು ನಿರಾಕರಣೆಯು ಕಾದು ಮತ್ತೆ ಪ್ರಯತ್ನಿಸಲು ಹೇಳಿದಾಗ ಮಾತ್ರ. ದೋಷಗಳು ನೋಡಿ. - ಪ್ರತಿ webhook ನ ಸಹಿಯನ್ನು ಪರಿಶೀಲಿಸಿ ಅದನ್ನು ನಂಬುವ ಮೊದಲು. Webhooks ನೋಡಿ.