跳转到内容

வலைப்பிணைப்புகள்

வெப்ஹுக் URL அமைக்கப்பட்டிருந்தால், ஒரு கோப்பு மொழிபெயர்ப்புப் பணி (/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 ஒவ்வொரு webhook-ன் கடைசி தூண்டல் நேரம், நிலைக் குறியீடு மற்றும் தொடர்ச்சியான தோல்விகளைக் காட்டுகிறது