شرایط API

۱.چه کسی به API دسترسی دارد

‏API آرا هلث ارائه می‌شود به:

• مشتریان طرح استاندارد پلاس، پریمیوم یا سازمانی ، فقط برای استفاده با داده خودشان.
• همکاران تأییدشده زیر قرارداد کتبی یکپارچه‌سازی (ببینید شرایط همکاری).
• همکاران بازفروشان زیر قرارداد بازفروشی جداگانه.

‏API در طرح استاندارد یا برای غیرمشتریان در دسترس نیست.

۲.احراز هویت

۲.۱OAuth ۲.۰

یکپارچه‌سازی سرور-به-سرور از OAuth ۲.۰ client credentials استفاده می‌کند. توکن‌ها کوتاه‌عمرند (۳۶۰۰ ثانیه) و با جریان‌های استاندارد OAuth تازه می‌شوند.

۲.۲کلیدهای API

کلیدهای API بلندعمر برای اتوماسیون داخلی موجود است. کلیدها به یک کسب‌وکار و مجموعه تعریف‌شده محدوده‌ها محدودند. کلیدها باید حداقل هر ۱۲ ماه و در صورت شک به افشا فوراً چرخانده شوند.

۲.۳محدوده‌ها

‏API محدوده‌محور است. فهرست کامل محدوده‌ها مستند شده در panel.arahealth.ir/developers/scopes. اصل، حداقل امتیاز است: فقط محدوده‌هایی را بخواهید که یکپارچه‌سازی شما لازم دارد.

۳.محدودیت‌های نرخ

عبور از سقف دقیقه‌ای HTTP ۴۲۹ برمی‌گرداند با هدر Retry-After . مشتریان سازمانی می‌توانند کتباً محدودیت بالاتر بخواهند.

۴.استفاده مجاز

کاربران API نباید:

• داده بیمار را برای هدفی جز خدمت به کلینیک مالکش برداشت کنند.
• دسترسی API را به اشخاص ثالث بازفروش یا واگذاری مجوز کنند.
• از API برای دورزدن محدودیت نرخ، گزارش حسابرسی یا دیوار پرداخت محصول استفاده کنند.
• بدون رضایت کتبی ما از API برای نرم‌افزار رقیب مدیریت مطب استفاده کنند.
• از API به شکلی که تعهدات حفاظت داده کلینیک را نقض کند استفاده کنند.
• از API برای بازاریابی ناخواسته بیمار خلاف قانون حریم الکترونیک استفاده کنند.

۵.مالکیت داده

کلینیک مشتری مالک داده بالینی و بیمارانش است. آرا هلث آن داده را به‌عنوان پردازشگر کلینیک پردازش می‌کند. API مالکیت را منتقل نمی‌کند؛ همکاران یکپارچه‌سازی با همان تعهدات پردازشگری مقیدند از طریق شرایط همکاری.

۶.نسخه‌بندی و توقف

‏API با طرح تاریخ‌محور نسخه‌بندی می‌شود (۲۰۲۶-۰۶-۲۸). متعهدیم به:

• اطلاع شش‌ماهه پیش از هر تغییر شکننده. اطلاعیه در پرتال توسعه‌دهندگان و ایمیل به هر مصرف‌کننده فعال API.
• نسخه منسوخ برای کل دوره اطلاع، پاسخ‌های درست می‌دهد.
• تغییرات غیرشکننده (فیلدهای افزوده، نقاط جدید، محدوده‌های اضافه) می‌تواند بدون اطلاع عرضه شود.
• تغییرات امنیتی می‌تواند با اطلاع کوتاه‌تر و کمترین اثر ممکن عرضه شود.

۷.سطح خدمت و دردسترس‌بودن

هدف ما دسترسی ماهانه ۹۹٫۹٪ برای API عملیاتی؛ بدون نگهداری برنامه‌ریزی‌شده. وضعیت منتشر می‌شود در status.arahealth.ir. اگر دردسترس‌بودن ماهانه زیر هدف بیفتد، مشتری مستحق اعتبار خدمت است؛ درصدی از حق اشتراک ماهانه:

اعتبارها ظرف ۳۰ روز از ماه متأثر کتباً مطالبه می‌شود.

۸.سقف مسئولیت

تا بیشترین حد مجاز قانون، مجموع مسئولیت آرا هلث ناشی از استفاده API به هزینه‌های قابل انتساب به دسترسی API در ۱۲ ماه پیش از رویداد منشأ ادعا محدود است. هیچ‌چیز مسئولیت فوت یا آسیب شخصی، تقلب یا هر مسئولیت غیرقابل استثنا طبق قانون حاکم را محدود نمی‌کند. ببینید شرایط و ضوابط، بند ۹ برای محدودیت کامل.

۹.فسخ

دسترسی API می‌تواند به این دلایل معلق یا قطع شود:

• نقض اساسی این شرایط که ظرف ۱۴ روز از اطلاع کتبی جبران نشود.
• نقض مکرر محدودیت نرخ یا استفاده مجاز پس از هشدار.
• رخداد امنیتی قابل انتساب به نحوه نگهداری اعتبارنامه‌ها توسط یکپارچه‌ساز.
• پایان اشتراک مشتری زیرین.

قطع دسترسی، لغو اعتبارنامه‌ها و پنجره ۳۰ روزه برای خروجی داده‌هایی را فعال می‌کند که یکپارچه‌ساز طبق دستور کتبی کلینیک مستحق آن است.

۱۰.تعاریف

اصطلاحات به‌کاررفته در این سند معانی زیر را دارند.

۱۱.تماس برای پرسش‌ها