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