API مجموعه Ziqme
REST، وبهوکها و رویدادهای بلادرنگ — همهچیز از یک درگاه واحد عبور میکند.
APIهای REST
نقاط پایانی REST نسخهبندیشده برای تیکتها، چتها، مشتریان، مقالات و گردش کارها — پشت یک درگاه واحد در api.ziqme.com.
وبهوکها
در رویدادهایی مانند ticket.created یا chat.started مشترک شوید و تحویلهای امضاشده را در نقاط پایانی خود دریافت کنید.
رویدادهای بلادرنگ
هابهای SignalR تیکتها، چتها و بهروزرسانیهای داشبورد را بهصورت زنده و مستقیم به اپلیکیشنهای شما استریم میکنند.
احراز هویت
با اعتبارنامههای کلاینت OAuth2 یا JWT کاربر احراز هویت کنید. هر درخواست زمینه فضای کاری شما را همراه دارد، بنابراین همیشه فقط دادههای خودتان را میبینید.
محدودیت نرخ درخواست
محدودیتهای نرخ مصرف منصفانه در سطح درگاه و به ازای هر فضای کاری اعمال میشود. پاسخها شامل هدرهای استاندارد هستند تا یکپارچهسازی شما بتواند بهدرستی سرعت خود را تنظیم کند.
نسخهبندی
APIها در URL نسخهبندی میشوند (در حال حاضر v1). تغییرات ناسازگار در قالب نسخه جدید منتشر میشوند — یکپارچهسازیهای موجود همچنان کار میکنند.
curl https://api.ziqme.com/api/v1/tickets \
-H "Authorization: Bearer $ZIQME_ACCESS_TOKEN"
HTTP/1.1 200 OK
{
"items": [
{
"id": "7d9f1c2e-4b6a-4f3d-9c1e-2a8b5d0e7f41",
"subject": "Order #1042 arrived damaged",
"status": "open",
"priority": "high"
}
],
"totalCount": 128
}