للمطورين
وقّعوا واختموا وتحقّقوا من برامجكم الخاصة Beta
طلب واحد يختم ملف PDF. وطلب آخر يرسله للتوقيع. ويمكن لأي شخص التحقق من النتيجة على verify.onwyn.io. صُمّم لمزودي أنظمة ERP وبرامج الأعمال الذين يريدون التوقيع داخل منتجهم الخاص.
اطلبوا مفتاح API عرض الطلبات التحقق من مستند
خلال المرحلة التجريبية (Beta) تُصدر Onwyn كل مفتاح API يدويًا. أخبرونا بالاسم القانوني الدقيق لشركتكم: فهو يُطبع على كل ختم.
ختمكم الأول في ثلاث خطوات
احصلوا على مفتاح
احفظوه على خادمكم، في متغير بيئة. لا تضعوه أبدًا في متصفح أو تطبيق.
export ONWYN_API_KEY='onwyn_test_XXXXXXXX'اختموا ملف PDF
يعود ملف PDF المختوم في الطلب نفسه. ويحمل الترويسة X-Onwyn-Code رمزه.
curl -sS --max-time 120 -D - -o sealed.pdf \ -H "Authorization: Bearer $ONWYN_API_KEY" \ -F file=@invoice.pdf -F ref=INV-2026-0001 \ https://sign.onwyn.io/api/sealتحقّقوا منه
التحقق عام ولا يحتاج إلى مفتاح. غيّروا حرفًا واحدًا في الملف ثم ارفعوه مرة أخرى: سيقول التحقق إنه قد تغيّر.
curl -sS https://verify.onwyn.io/api/v1/verify/code/ONW-4K7P-2M9X-QB3T
سبعة طلبات
خمسة طلبات على خادم التوقيع، كل منها بمفتاح API الخاص بكم. واثنان على خادم التحقق، عامّان ومجانيان.
| الطلب | ما يفعله |
|---|---|
POST /api/seal | إرسال ملف PDF. واستلام ملف PDF المختوم في الطلب نفسه. |
POST /api/sign | إرسال ملف PDF وما يصل إلى 10 موقِّعين. والحصول على رابط توقيع لكل موقِّع. |
GET /api/sign/{id} | معرفة مدى تقدّم التوقيع، موقِّعًا تلو الآخر. |
GET /api/sign/{id}/document | تنزيل ملف PDF النهائي. |
GET /api/sign/{id}/progress-copy | عدة موقِّعين: نسخة بعد التوقيع الأول. غير مختومة وغير نهائية. |
GET /api/v1/verify/code/{code} | التحقق من رمز. عام، دون مفتاح. |
POST /api/v1/verify/upload | التحقق من ملف PDF. عام، دون مفتاح. |
إرسال مستند للتوقيع
يحتوي الرد على رابط توقيع لكل موقِّع. تعرضون الرابط في منتجكم أو ترسلونه بأنفسكم. يفتحه الموقِّع في المتصفح، ويقرأ، ويوافق، ثم يوقّع، دون حساب ودون تطبيق. ومع عنوان عودة، يعود المتصفح بعد ذلك إلى منتجكم.
curl -sS --max-time 120 \
-H "Authorization: Bearer $ONWYN_API_KEY" \
-F file=@quotation.pdf -F 'signer_name=Anna Muster' -F ref=SO42 \
-F return_url=https://erp.example.com/orders/42 \
https://sign.onwyn.io/api/sign
- عدة موقِّعين.
- ما يصل إلى 10، واحدًا تلو الآخر أو جميعًا في الوقت نفسه.
- أين يوضع التوقيع.
- اكتبوا {{sign:1}} و{{date:1}} داخل ملف PDF، أو أرسلوا الصفحة والموضع.
- التوقيع فقط.
- أرسلوا seal=false للحصول على التوقيعات دون ختم Onwyn.
- اسم عميلكم على الختم.
- هل تبيعون لشركات كثيرة؟ أرسلوا company_name مع كل طلب، فيذكر الختم اسم عميلكم إلى جانب اسمكم.
- انتظار النتيجة.
- اطلبوا الحالة كل 5 إلى 10 ثوانٍ، أو عندما يعود الموقِّع إلى عنوان العودة الخاص بكم. ثم نزّلوا المستند.
الشيء نفسه بلغة Python
import os, requests
BASE = "https://sign.onwyn.io"
AUTH = {"Authorization": f"Bearer {os.environ['ONWYN_API_KEY']}"}
with open("quotation.pdf", "rb") as f:
r = requests.post(f"{BASE}/api/sign", headers=AUTH, timeout=120,
files={"file": ("quotation.pdf", f, "application/pdf")},
data={"signer_name": "Anna Muster", "ref": "SO42"})
r.raise_for_status()
request = r.json()
print(request["signers"][0]["signing_url"]) # give this link to the signer
status = requests.get(request["status_url"], headers=AUTH, timeout=30).json()
if status["status"] == "completed":
pdf = requests.get(status["document_url"], headers=AUTH, timeout=60).content
ما يجدر معرفته قبل البدء
- عبر API لا ترسل Onwyn أي بريد إلكتروني. تعطون كل موقِّع رابطه، ومن يفتح الرابط يمكنه التوقيع. ويذكر سجل الأدلة ذلك.
- إعادة إرسال الطلب نفسه تُنشئ مستندًا جديدًا. استخدموا مهلة انتظار قدرها 120 ثانية. عند تلقي 503 busy انتظروا عدد الثواني المذكور في Retry-After ثم أعيدوا المحاولة.
- لا توجد Webhooks في هذه الـ API بعد. اطلبوا الحالة بدلًا من ذلك.
- يمكن أن يصل حجم ملف PDF إلى 25 ميغابايت و100 صفحة. ويمكن لكل عنوان إجراء 30 عملية ختم و30 طلب توقيع في الدقيقة، وما يصل إلى 500 مستند في اليوم.
- خلال المرحلة التجريبية (Beta) تحتفظ Onwyn بنسختها من المستند لمدة 30 يومًا. نزّلوا ما تحتاجونه واحتفظوا به.
- كل خطأ يأتي بصيغة JSON مع رمز قصير وجملة واضحة تقول ما يجب تغييره.
- إنه توقيع إلكتروني بسيط، مختوم بشهادة Onwyn الخاصة وساعتها الخاصة. ما هي المرحلة التجريبية وما ليست هي.
يأتي مع مفتاحكم المرجع الكامل لـ API، مع أمثلة بلغات curl وPython وPHP وNode، مكتوب بحيث يمكنكم تسليمه إلى مساعد برمجة يعمل بالذكاء الاصطناعي.
أرسلوا مطوريكم إلينا
نخطّط للدمج مع فريقكم: أي الطلبات تُستخدم، وأين يوضع التوقيع، وكيف تظهر أسماء عملائكم على الختم.
تكلفة API هي نفسها تكلفة تطبيق الويب. اطّلعوا على الأسعار.
Onwyn Sign · حول · بيانات الناشر · الخصوصية · onwyn.io