نگارش و بازبینی: باربان · آخرین بازبینی:
پوش پاسخ و محیط آزمایشی
در پاسخ API، ابتدا وضعیت HTTP و سپس requestId، found و data را بخوانید. sandbox: true محیط آزمایشی را مشخص می‌کند. نبود این فیلد یا error: null در بعضی پاسخ‌های موفق مجاز است؛ قرارداد همان خدمت مرجع تفسیر پاسخ است.
ساختار و فیلدهای data
data می‌تواند شیء، آرایه یا مقدار ساده باشد. نام فیلدها و بزرگی و کوچکی حروف قرارداد راهداری را حفظ کنید. فیلد nullable یا غایب را با صفر، نام ساختگی یا وضعیت معتبر جایگزین نکنید؛ شکل داده هر خدمت در مرجع آن آمده است.
پاسخ خالی و خطای درخواست
found: false بدون خطای HTTP را از رد درخواست و اختلال جدا کنید. خطاهای اولیه ممکن است code و error متنی در ریشه داشته باشند؛ خطای سرویس می‌تواند error.code و error.message داشته باشد. همه این حالت‌ها باید اقدام بعدی مناسب خود را داشته باشند.
واحدها و اطلاعات پیگیری
واحد هر مقدار از قرارداد می‌آید: در نرخ عرف حمل، Price به ریال، Distance به کیلومتر و weight ورودی به تن است. شناسه درخواست و کد خطا برای پیگیری‌اند؛ کلید API و نتیجه خصوصی استعلام نباید به ابزار آمار یا گزارش عمومی فرستاده شوند.
منبع و ادامه بررسی
این راهنما بر اساس قرارداد جاری خدمات باربان نوشته شده است؛ نتیجه هر استعلام و شرایط استفاده را در خدمت مربوط بررسی کنید.