رفتن به محتوا

احراز هویت درخواست API

کلید API مربوط به Threetone را در سرآیند x-api-key بفرستید و اطلاعات ورود را از کد سمت کاربر دور نگه دارید.

به‌روزرسانی‌شده در

فرستادن سرآیند کلید API

API عمومی برنامه‌نویسی از https://api.threetone.in ارائه می‌شود. کلید API را در سرآیند درخواست x-api-key بفرستید:

curl --request GET \
  --url 'https://api.threetone.in/v1/convai/agents' \
  --header "x-api-key: $THREETONE_API_KEY"

کلید را به‌عنوان مقدار سرآیند استفاده کنید. آن را در URL، رشته پرس‌وجو یا بدنه درخواست نگذارید. درخواست برنامه‌ای باید x-api-key بفرستد؛ فرستادن هم‌زمان آن با سرآیند Authorization به‌دلیل ابهام در اطلاعات ورود رد می‌شود.

نگه‌داشتن کلید در سرور

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

ثبت شناسه درخواست

Threetone سرآیند پاسخ X-Request-Id را برمی‌گرداند. هنگام رفع مشکل، مقدار آن را همراه با زمان، روش، مسیر و وضعیت درخواست نگه دارید. همچنین می‌توانید X-Request-Id معتبر خود را بفرستید؛ API آن را در پاسخ بازمی‌گرداند.

مقاله‌های مرتبط