شروع کار با API تینکزو

احراز هویت

تمام درخواست‌های API با یک کلید احراز هویت می‌شوند. کلید را از بخش تنظیمات حساب خود بسازید و آن را در هدر هر درخواست بفرستید.

curl https://api.tinkzo.com/v1/devices \
  -H "x-api-key: YOUR_API_KEY"

نگهداری از کلید

کلید API مثل رمز عبور است. آن را در کد سمت مرورگر یا در مخزن گیت قرار ندهید. اگر کلیدی لو رفت، از پنل باطلش کنید و کلید تازه بسازید.

قالب پاسخ

همه پاسخ‌ها یک شکل دارند تا کد شما لازم نباشد برای هر مسیر جداگانه نوشته شود.

{
  "success": true,
  "data": { },
  "meta": { }
}

محدودیت نرخ

برای حفظ پایداری سرویس، تعداد درخواست‌ها در هر بازه محدود است. اگر به سقف برسید پاسخ با کد ۴۲۹ برمی‌گردد و باید کمی صبر کنید.

نوع درخواست	سقف	بازه
خواندن	۳۰۰	۱۵ دقیقه
نوشتن	۶۰	۱ دقیقه