跳转到内容

ವೆಬ್‌ಹುಕ್ಸ್

ವೆಬ್‌ಹುಕ್ ಯುಆರ್‌ಎಲ್ ಅನ್ನು ಹೊಂದಿಸಿದ ನಂತರ, ಫೈಲ್ ಅನುವಾದ ಕಾರ್ಯ (/jobs) ಮುಕ್ತಾಯಗೊಂಡಾಗ (ಯಶಸ್ವಿಯಾಗಿದ್ದರೂ ಅಥವಾ ಇಲ್ಲದಿದ್ದರೂ) ನಿಮ್ಮ ಸರ್ವರ್‌ಗೆ ಸೂಚನೆ ನೀಡಲಾಗುತ್ತದೆ. POST /jobs/{id}/cancel ನಿಂದ ರದ್ದುಗೊಳಿಸಲಾದ ಕಾರ್ಯಗಳು ಯಾವುದೇ ಕಾಲ್‌ಬ್ಯಾಕ್ ಕಳುಹಿಸುವುದಿಲ್ಲ. ದಾಖಲೆ ಕಾರ್ಯಾಚರಣೆಗಳು ಮತ್ತು ಮಾಧ್ಯಮ ಕಾರ್ಯಗಳಿಗಾಗಿ, ಅವುಗಳ ಸ್ವಂತ ಪ್ರಶ್ನೆ ಅಂತ್ಯಬಿಂದುಗಳನ್ನು ಪೋಲ್ ಮಾಡಿ.

ವೆಬ್‌ಹುಕ್‌ಗಳನ್ನು ನಿರ್ವಹಿಸಿ

Section titled “ವೆಬ್‌ಹುಕ್‌ಗಳನ್ನು ನಿರ್ವಹಿಸಿ”

API ಮೂಲಕ ನಿರ್ವಹಿಸಲಾಗುತ್ತದೆ, ಪ್ರತಿ ಬಳಕೆದಾರರಿಗೆ 3 ವರೆಗೆ:

POST /api/v1/webhooks create
GET /api/v1/webhooks list
PATCH /api/v1/webhooks/{id} update / disable
DELETE /api/v1/webhooks/{id} delete

ಉದಾಹರಣೆ ರಚಿಸಿ:

Terminal window
curl -X POST https://omnidoc.top/api/v1/webhooks \
-H "X-API-Key: sk_your_key" \
-H "Content-Type: application/json" \
-d '{
"url": "https://your-server.com/hooks/omnidoc",
"secret": "your-signing-secret",
"events": ["job.completed"],
"description": "Production callback"
}'

URL ಅನ್ನು ಸಾರ್ವಜನಿಕ ಇಂಟರ್ನೆಟ್‌ನಿಂದ ತಲುಪಬಹುದಾಗಿರಬೇಕು, ಸಾಧ್ಯವಾದರೆ HTTPS ಮೂಲಕ; ಖಾಸಗಿ ನೆಟ್‌ವರ್ಕ್‌ಗಳು, ಸ್ಥಳೀಯ ವಿಳಾಸಗಳು ಮತ್ತು ತಪ್ಪಾದ URL ಗಳು 400 ಅನ್ನು ಹಿಂದಿರುಗಿಸುತ್ತವೆ. PATCH url, secret, events, description ಮತ್ತು status (active / disabled) ಅನ್ನು ಬದಲಾಯಿಸಬಹುದು.

ಕಾಲ್‌ಬ್ಯಾಕ್ ಫಾರ್ಮ್ಯಾಟ್

Section titled “ಕಾಲ್‌ಬ್ಯಾಕ್ ಫಾರ್ಮ್ಯಾಟ್”
POST your-webhook-url
Content-Type: application/json
X-Webhook-Event: job.completed
X-Webhook-Timestamp: 1782900150
X-Webhook-Signature: sha256=...
{
"event": "job.completed",
"timestamp": 1782900150,
"data": {
"job_id": "q3f8s6c2a9m1k4tx",
"status": "completed",
"file_name": "report.docx",
"char_count": 12840
}
}
ಘಟನೆWhen
job.completedಒಂದು ಕಾರ್ಯ ಮುಕ್ತಾಯಗೊಳ್ಳುತ್ತದೆ; data.status ಎಂದರೆ completed ಅಥವಾ failed

ವಿಫಲವಾದ ಕೆಲಸಗಳು job.completed ಘಟನೆಯನ್ನೂ ಬಳಸುತ್ತವೆ; ಅವುಗಳನ್ನು data.status == "failed" ಮತ್ತು ಐಚ್ಛಿಕ data.error ಮೂಲಕ ಪ್ರತ್ಯೇಕಿಸಿ. ಯಶಸ್ವಿ ಕೆಲಸಗಳು error ಕ್ಷೇತ್ರವನ್ನು ಹೊಂದಿರುವುದಿಲ್ಲ. data.char_count ಎಂಬುದು ಅನುವಾದದಲ್ಲಿರುವ ಅಕ್ಷರಗಳ ಸಂಖ್ಯೆಯಾಗಿದ್ದು, ವಿಫಲವಾದ ಕೆಲಸಗಳಿಗೆ 0 ಬಳಸಲಾಗುತ್ತದೆ.

events ಕೇವಲ job.completed ಮತ್ತು * (ಎಲ್ಲಾ ಘಟನೆಗಳು) ಅನ್ನು ಸ್ವೀಕರಿಸುತ್ತದೆ; ಇತರ ಮೌಲ್ಯಗಳು ಅಥವಾ ಖಾಲಿ ಪಟ್ಟಿಯು 422 ಅನ್ನು ಹಿಂದಿರುಗಿಸುತ್ತದೆ. PATCH ನಲ್ಲಿ, ನೀವು ಬದಲಾಯಿಸದ ಕ್ಷೇತ್ರಗಳನ್ನು ಬಿಡಿ; null ಅನ್ನು ಕಳುಹಿಸುವುದು ಸಹ 422 ಅನ್ನು ಹಿಂದಿರುಗಿಸುತ್ತದೆ.

ಸಹಿಯನ್ನು ಪರಿಶೀಲಿಸಿ

Section titled “ಸಹಿಯನ್ನು ಪರಿಶೀಲಿಸಿ”

ವೆಬ್‌ಹುಕ್‌ನಲ್ಲಿ secret ಅನ್ನು ಹಾಕಿದಾಗ, ಪ್ರತಿ ಕಾಲ್‌ಬ್ಯಾಕ್ X-Webhook-Signature ಅನ್ನು ಒಳಗೊಂಡಿರುತ್ತದೆ. ಇದನ್ನು ರಾ ರೆಕ್ವೆಸ್ಟ್ ಬಾಡಿ ಮೂಲಕ HMAC-SHA256 ಬಳಸಿ ಪರಿಶೀಲಿಸಿ:

import hashlib
import hmac
import json
import time
def verify_webhook(payload: bytes, signature: str, secret: str) -> bool:
expected = hmac.new(
secret.encode(), payload, hashlib.sha256
).hexdigest()
return hmac.compare_digest(f"sha256={expected}", signature)
def parse_webhook(payload: bytes, signature: str, secret: str, tolerance: int = 12 * 3600) -> dict:
if not verify_webhook(payload, signature, secret):
raise ValueError("invalid signature")
event = json.loads(payload)
if abs(time.time() - event["timestamp"]) > tolerance:
raise ValueError("stale event")
return event

ಸಹಿಯು ದೇಹವನ್ನು ಮಾತ್ರ ಒಳಗೊಂಡಿದೆ, ತಲೆಬರಹಗಳನ್ನಲ್ಲ. ಪುನರಾವರ್ತನೆ ರಕ್ಷಣೆಗಾಗಿ, ಸಹಿ ಯಶಸ್ವಿಯಾದ ನಂತರ ದೇಹದಲ್ಲಿ timestamp ಅನ್ನು ಪರಿಶೀಲಿಸಿ (ಇದು X-Webhook-Timestamp ಗೆ ಸಮಾನವಾಗಿದೆ, ಆದರೆ ಕೇವಲ ದೇಹದ ಮೌಲ್ಯವನ್ನು ಮಾತ್ರ ಸಹಿ ಮಾಡಲಾಗುತ್ತದೆ), ಮತ್ತು data.job_id ಮತ್ತು data.status ಮೂಲಕ ಡುಪ್ಲಿಕೇಟ್‌ಗಳನ್ನು ತೆಗೆದುಹಾಕಿ. ಪುನರಾವರ್ತನೆಗಳು ಮೊದಲ ವಿತರಣೆಯ ದೇಹವನ್ನು ಯಥಾಸ್ಥಿತಿಯಲ್ಲಿ ಮತ್ತೆ ಕಳುಹಿಸುತ್ತವೆ, ಅದೇ timestamp ಜೊತೆಗೆ, ಮತ್ತು ಕೊನೆಯ ಪುನರಾವರ್ತನೆಯು ಮೊದಲ ವಿತರಣೆಯಿಂದ ಸುಮಾರು 8.6 ಗಂಟೆಗಳ ನಂತರ ಬರುತ್ತದೆ, ಆದ್ದರಿಂದ ಕಿಟಕಿಯನ್ನು ಅದಕ್ಕಿಂತ ಕಡಿಮೆ ಅವಧಿಗೆ ಮಾಡಬೇಡಿ (ಉದಾಹರಣೆಯು 12 ಗಂಟೆಗಳನ್ನು ಬಳಸುತ್ತದೆ).

  • ಡೆಲಿವರಿ ಯಶಸ್ವಿಯಾಗಿದೆ ಎಂದು ಪರಿಗಣಿಸಲು, ರಿಸೀವರ್ 15 ಸೆಕೆಂಡುಗಳ ಒಳಗೆ 2xx ಅನ್ನು ಹಿಂತಿರುಗಿಸಬೇಕು; ರೀಡೈರೆಕ್ಟ್‌ಗಳನ್ನು ಅನುಸರಿಸಲಾಗುವುದಿಲ್ಲ
  • ವಿಫಲವಾದ ವಿತರಣೆಗಳು (ಟೈಮ್‌ಔಟ್, ಸಂಪರ್ಕ ದೋಷ ಅಥವಾ 2xx ಹೊರತುಪಡಿಸಿ) ಸ್ವಯಂಚಾಲಿತವಾಗಿ ಪುನರ್‌ಪ್ರಯತ್ನಿಸಲ್ಪಡುತ್ತವೆ: ಹಿಂದಿನ ವೈಫಲ್ಯದ 1 ನಿಮಿಷ, 5 ನಿಮಿಷ, 30 ನಿಮಿಷ, 2 ಗಂಟೆ ಮತ್ತು 6 ಗಂಟೆಗಳ ನಂತರ, ಒಂದು ಘಟನೆಗೆ ಗರಿಷ್ಠ 6 ವಿತರಣೆಗಳು, ನಂತರ ಇನ್ನು ಯಾವುದೇ ವಿತರಣೆ ಇರುವುದಿಲ್ಲ
  • ಮರುಪ್ರಯತ್ನಗಳು ದೇಹವನ್ನು ಬದಲಾಯಿಸದೆ (timestamp, data ಮತ್ತು ಸಹಿ ಮೊದಲ ವಿತರಣೆಯೊಂದಿಗೆ ಹೊಂದಾಣಿಕೆಯಾಗುತ್ತದೆ; secret ನಡುವೆ ಬದಲಾದರೆ, ಹೊಸ secret ಸಹಿ ಮಾಡುತ್ತದೆ) ವೆಬ್‌ಹುಕ್‌ನ ಪ್ರಸ್ತುತ URL ಗೆ ಹೋಗುತ್ತದೆ; ಈಗಾಗಲೇ ವಿತರಿಸಲಾದ ಘಟನೆಗಳನ್ನು ಮತ್ತೆ ಕಳುಹಿಸಲಾಗುವುದಿಲ್ಲ
  • ವೆಬ್‌ಹುಕ್ ಅನ್‌ಎನೇಬಲ್ ಮಾಡಲ್ಪಟ್ಟಾಗ, ಅದನ್ನು ಅಳಿಸಲ್ಪಟ್ಟಾಗ ಅಥವಾ ಆ ಘಟನೆಗೆ ಚಂದಾದಾರಿಕೆ ಇಲ್ಲದಾಗ, ಅದರ ಪೆಂಡಿಂಗ್ ಪುನರ್‌ಪ್ರಯತ್ನಗಳನ್ನು ರದ್ದುಗೊಳಿಸಲಾಗುತ್ತದೆ
  • ಸ್ವೀಕರಿಗಳು data.job_id ಮತ್ತು data.status ಪ್ರಕಾರ ಘಟನೆಗಳನ್ನು ಇಡ್ಪೋಟೆಂಟ್‌ಆಗಿ ನಿರ್ವಹಿಸಬೇಕು ಮತ್ತು ಅವುಗಳನ್ನು ಸುರಕ್ಷಿತವಾಗಿ ಉಳಿಸಿದ ನಂತರ ತಕ್ಷಣ ಪ್ರತಿಕ್ರಿಯಿಸಬೇಕು.
  • ಒಂದು ಖಾತೆಯ ಬಹು ವೆಬ್‌ಹೂಕ್‌ಗಳನ್ನು ಸಮಾಂತರವಾಗಿ ವಿತರಿಸಲಾಗುತ್ತದೆ; ನಿಧಾನವಾಗಿ ಸ್ವೀಕರಿಸುವ ವ್ಯವಸ್ಥೆಯು ಇತರ ವೆಬ್‌ಹೂಕ್‌ಗಳನ್ನು ತಡೆಯುವುದಿಲ್ಲ
  • ಸತತ 10 ವೈಫಲ್ಯದ ಡೆಲಿವರಿಗಳ (ಮರುಪ್ರಯತ್ನಗಳು ಸೇರಿ) ನಂತರ, webhook ಅನ್ನು ಸ್ವಯಂಚಾಲಿತವಾಗಿ ನಿಷ್ಕ್ರಿಯಗೊಳಿಸಲಾಗುತ್ತದೆ; ರಿಸೀವರ್ ಸರಿಪಡಿಸಿದ ನಂತರ PATCH ಬಳಸಿ ಅದನ್ನು ಮರು-ಸಕ್ರಿಯಗೊಳಿಸಿ
  • GET /api/v1/webhooks ಪ್ರತಿ ವೆಬ್‌ಹುಕ್‌ನ ಕೊನೆಯ ಟ್ರಿಗರ್ ಸಮಯ, ಸ್ಟೇಟಸ್ ಕೋಡ್ ಮತ್ತು ಸತತ ವೈಫಲ್ಯಗಳನ್ನು ತೋರಿಸುತ್ತದೆ