قرارداد ایپیآی
API contract
توافق دقیق درباره شکل درخواستها، پاسخها و خطاهای یک ایپیآی که هر دو طرف به آن پایبندند.
قرارداد ایپیآی (API contract) تعریف دقیق این است که یک ایپیآی چه درخواستی میپذیرد، چه پاسخی برمیگرداند، چه خطاهایی ممکن است رخ دهد و هر فیلد چه معنایی دارد. این قرارداد معمولاً به شکل ماشینخوان، مثلاً با OpenAPI، نوشته میشود.
وقتی قرارداد پایدار باشد، سازنده و مصرفکننده ایپیآی میتوانند مستقل کار کنند. در ایران اوپن فاینانس قراردادها در شبیهساز و محیط واقعی یکساناند؛ پس محصولی که روی شبیهساز ساخته شده، هنگام اتصال واقعی همان رفتار را میبیند. تغییر در قرارداد باید با نسخهبندی مدیریت شود.
قسمت صوتی این واژه در ۱۵ اسفند ۱۴۰۵ در «یک دقیقه با ایران اوپن فاینانس» منتشر میشود.
واژههای مرتبط
ایپیآیAPI (Application Programming Interface)راهی استاندارد که یک نرمافزار با آن از نرمافزار دیگر داده میگیرد یا از آن میخواهد کاری انجام دهد.مشخصات اوپنایپیآیOpenAPI Specificationاستانداردی رایج برای نوشتن قرارداد ایپیآی به شکلی که هم انسان و هم ماشین بتوانند آن را بخوانند.نسخهبندی ایپیآیAPI versioningروشی برای تغییر دادن ایپیآی بدون خراب کردن برنامههایی که از نسخه قبلی استفاده میکنند.شبیهسازSimulatorمحیطی که رفتار کامل بانکها، شرکتهای پرداخت و بیمهها را با داده نمونه بازسازی میکند تا محصول پیش از اتصال واقعی ساخته شود.