Public API و Webhook
بسازید، وصل کنید، خودکار کنید
API نسخهدار با OAuth2/OIDC و Service Account، Webhook با امضای HMAC، Retry نمایی و Replay کنترلشده؛ همه روی Event Catalog مشترک ERP/CRM و مانیتورینگ.
# List open deals
curl https://triliz.tecladz.com/api/v1/deals?stage=new \
-H "Authorization: Bearer $TOKEN" \
-H "Idempotency-Key: 7f1c…"
# → 200 OK
{
"data": [{ "id": 4821, "title": "پروژه ERP", "amount": 450000000 }],
"next_cursor": "eyJpZCI6NDgyMX0"
}
Public API
اصول طراحی API
REST و GraphQL نسخهدار
تغییرات ناسازگار فقط در نسخه جدید منتشر میشود.
OAuth2/OIDC و Service Account
دسترسی کاربر و دسترسی ماشین جدا و با Scope.
Pagination و Idempotency
Cursor-based pagination و کلید یکتایی برای عملیات نوشتن.
Rate Limit و Quota
محدودیت منصفانه برای هر اپ و Tenant.
Audit
هر فراخوانی حساس ثبت میشود.
Developer Portal
ثبت اپ، چرخش کلید، مستندات و Test Tenant.
Webhook
رویدادها را لحظهای دریافت کنید
Subscription با فیلتر، Retry نمایی، Replay کنترلشده، Delivery Log و صف پیامهای ناموفق. ترتیب ارسال best-effort است؛ هر رویداد شناسه یکتا دارد.
- امضای HMAC و Timestamp در هدر
- چرخش Secret بدون قطع سرویس
- داده حساس فقط با Scope و Redaction
// Verify signature (PHP)
$ts = $request->header('X-Triliz-Timestamp');
$sig = $request->header('X-Triliz-Signature');
$exp = 'sha256=' . hash_hmac(
'sha256', $ts . '.' . $request->getContent(), $secret
);
if (!hash_equals($exp, $sig) || abs(time() - $ts) > 300) {
abort(401);
}
Event Catalog
نمونه رویدادها
فهرست نهایی رویدادها در Developer Portal منتشر میشود.
| رویداد | توضیح | حوزه |
|---|---|---|
| work.task.created | ساخت کار جدید | مدیریت کار |
| work.task.completed | تکمیل کار | مدیریت کار |
| time.entry.approved | تأیید ساعت کار | تایملاگ |
| crm.deal.won | بستهشدن فرصت فروش | CRM |
| ticket.created | ثبت تیکت | پشتیبانی |
| ticket.resolved | حل تیکت | پشتیبانی |
| form.approved | تأیید فرم | فرمساز |
| monitor.session.started | شروع Session مانیتورینگ | مانیتورینگ |
| monitor.session.ended | پایان Session مانیتورینگ | مانیتورینگ |
| monitor.grant.revoked | لغو Grant | مانیتورینگ |
آماده ساخت اولین اتصال هستید؟
یک Tenant آزمایشی بسازید و کلید API خود را از پنل دریافت کنید.