Api چیست؟
رابط برنامهنویسی کاربردی یا API مخفف Application Programming Interface است
API در واقع یک واسطه نرم افزاری است که به دو برنامه اجازه می دهد تا با یکدیگر صحبت کنند. Api به شما امکان فراخوانی و یا ارسال اطلاعات را در دو یا چند سیستم امکان پذیر می سازد. از آنجایی که گاها سازمان ها از نرم افزارهای جزیره ای استفاده می نمایند و در برخی سیستم ها نیاز به فراخوانی برخی اطلاعات از سایر سیستم ها داریمف تیم فنی انعکاس برای بخش های مختلف سیستم api تولید نموده و در اختیار شما قرار می دهد
Api ارائه شده به صورت REST می باشد و تمام درخواست های با متدهای(PUT ,POST ,GET DELETE) را با توجه به نوع درخواست مشتری ارسال می شوند و تمام پاسخ ها به صورت JSON می باشد.
تعاریف و اصطلاحات
- میزبان: منظور شرکتی است که نرم افزار مالی انعکاس بر روی سرور آنها نصب گردیده است.
- مصرف کننده: منظور شرکتی است که تمایل دارد از api انعکاس در نرم افزار خود استفاده نماید.
- نام کاربری: از این نام کاربری برای شناسایی مصرف کننده api و اهراز هویت درخواست ارسالی استفاده می شود. این نام کاربری به ازای هر مصرف کننده متفاوت می باشد و توسط شرکت انعکاس ارائه می گردد.
- کلید خصوصی: از این کلید برای اهراز هویت درخواست ارسالی استفاده می گردد. این کلید به ازای هر مصرف کننده متفاوت می باشد و توسط شرکت انعکاس ارائه می گردد.