شروع سریع
فقط به یک حساب، یک کلید و یک درخواست HTTP نیاز دارید.
۱. حساب و کلید ایجاد کنید
ثبت‌نام کنید و ایمیل خود را تأیید کنید. پلن رایگان خودکار فعال می‌شود. بعد در صفحه کلیدها یک کلید ایجاد کنید و جای امنی نگهش دارید، چون فقط یک بار نمایش داده می‌شود.
۲. کلید را بررسی کنید
این درخواست رایگان است و پلن، موجودی و محدودیت‌های شما را نشان می‌دهد.
کلید را بچسبانید تا نمونه‌کدها پر شوند و بتوانید درخواست بفرستید. تا وقتی صفحه را دوباره باز نکنید فقط در همین تب می‌ماند. هیچ‌جا ذخیره نمی‌شود. گرفتن کلید
curl -sS "https://api.arzdigital.com/v1/key/info" \
-H "X-API-Key: YOUR_API_KEY"۳. اولین درخواست را بفرستید
این درخواست ۱۰ دارایی برتر را می‌گیرد. چون ۱۰ ردیف برمی‌گرداند، ۱ اعتبار مصرف می‌کند.
curl -sS "https://api.arzdigital.com/v1/assets?limit=10&sort=rank_asc" \
-H "X-API-Key: YOUR_API_KEY"۴. هدرهای پاسخ را ببینید
هر پاسخ می‌گوید آن درخواست چقدر هزینه داشت و چقدر جا برایتان مانده است.
| هدر | معنی |
|---|---|
X-Credits-Charged | اعتباری که این درخواست مصرف کرد. برای هر پاسخی غیر از ۲۰۰، مقدارش 0 است. |
X-Credits-Remaining | موجودی حساب پس از این درخواست، بدون احتساب اعتباری که درخواست‌های هنوز در حال اجرا کنار گذاشته‌اند. فقط وقتی منفی است که حساب پس از یک اصلاح دستی بدهکار باشد. |
X-RateLimit-Limit | تعداد درخواست مجاز این کلید در هر دقیقه. |
X-RateLimit-Remaining | تعداد درخواستی که در بازه فعلی باقی مانده است. |
X-RateLimit-Reset | زمانی که دوباره جا برای درخواست باز می‌شود، به ثانیه یونیکس. |
چند نکته
- API را از سرور خود صدا بزنید، نه از مرورگر. API هدر CORS نمی‌فرستد و کلیدی که در صفحه وب باشد را هر کسی می‌تواند کپی کند.
- کلید را فقط در هدر X-API-Key بفرستید. کلید در نشانی پذیرفته نمی‌شود، چون نشانی‌ها در لاگ‌ها ثبت می‌شوند.
- اول کد وضعیت HTTP را بررسی کنید. در پاسخ موفق، فیلد status کلمه success است و در خطا، شیئی شامل کد و پیام.