---
term: "قرارداد ای‌پی‌آی"
english: "API contract"
category: "اوپن فاینانس و API"
url: https://iranopenfinance.com/glossary/api-contract
source: Iran Open Finance (ایران اوپن فاینانس) glossary
---

# قرارداد ای‌پی‌آی (API contract)

> توافق دقیق درباره شکل درخواست‌ها، پاسخ‌ها و خطاهای یک ای‌پی‌آی که هر دو طرف به آن پایبندند.

قرارداد ای‌پی‌آی (API contract) تعریف دقیق این است که یک [ای‌پی‌آی](/glossary/api) چه درخواستی می‌پذیرد، چه پاسخی برمی‌گرداند، چه خطاهایی ممکن است رخ دهد و هر فیلد چه معنایی دارد. این قرارداد معمولاً به شکل ماشین‌خوان، مثلاً با [OpenAPI](/glossary/openapi)، نوشته می‌شود.

وقتی قرارداد پایدار باشد، سازنده و مصرف‌کننده ای‌پی‌آی می‌توانند مستقل کار کنند. در ایران اوپن فاینانس قراردادها در [شبیه‌ساز](/glossary/simulator) و محیط واقعی یکسان‌اند؛ پس محصولی که روی شبیه‌ساز ساخته شده، هنگام اتصال واقعی همان رفتار را می‌بیند. تغییر در قرارداد باید با [نسخه‌بندی](/glossary/api-versioning) مدیریت شود.

Related: [ای‌پی‌آی](https://iranopenfinance.com/glossary/api.md)، [مشخصات اوپن‌ای‌پی‌آی](https://iranopenfinance.com/glossary/openapi.md)، [نسخه‌بندی ای‌پی‌آی](https://iranopenfinance.com/glossary/api-versioning.md)، [شبیه‌ساز](https://iranopenfinance.com/glossary/simulator.md)