نگارش و بازبینی: باربان · آخرین بازبینی:
انتخاب خدمت و دسترسی
در مرجع API، خدمت، پارامترها و scope را بررسی کنید. پس از ورود، سازمان بسازید و مشخصات حقوقی آن را تکمیل کنید. سپس اشتراک قابل استفاده یا مصرف بدون بسته را با تعرفه جاری و شرایط کیف پول ریالی سازمان فعال کنید. ورود به سایت به‌تنهایی کلید ایجاد نمی‌کند؛ ساخت کلید اقدام جداگانه و دارای نقش مجاز است.
ارسال درخواست بارنامه از سرور
برای بارنامه با پلاک، POST /api/v1/waybills/by-plate را با بدنه JSON شامل plateLeft، plateLetter، plateRight و plateCity بفرستید. هدرهای X-API-Key و Content-Type: application/json لازم‌اند. کلید را در سرور خصوصی نگه دارید؛ نمونه‌های اجرایی در صفحه همین خدمت قرار دارند.
بررسی اتصال با کلید آزمایشی
در بخش کلیدهای سازمان، کلید Sandbox با scope خدمت بسازید و مقدار کامل آن را همان لحظه در سرور امن نگه دارید؛ کلید فقط یک‌بار نمایش داده می‌شود. پاسخ sandbox: true ساختار و دسترسی را بررسی می‌کند و داده واقعی راهداری نیست. کسر سهمیه Sandbox به قرارداد خریداری‌شده بستگی دارد؛ سهمیه و محدودیت نرخ را در پلن و گزارش مصرف بخوانید.
تفسیر پاسخ و پیگیری عملیات
وضعیت HTTP را پیش از found، sandbox و data بررسی کنید. برای هر عملیات، Idempotency-Key ثابتی نگه دارید؛ پس از قطع ارتباط، شناسه تازه خودکار نسازید. نتیجه خالی، ورودی ردشده و خطای سرویس را جدا مدیریت کنید و وضعیت مصرف را پیش از آغاز عملیات تازه بخوانید.
منبع و ادامه بررسی
این راهنما بر اساس قرارداد جاری خدمات باربان نوشته شده است؛ نتیجه هر استعلام و شرایط استفاده را در خدمت مربوط بررسی کنید.