تعریف
کلید API رشته رمز طولانی است که برنامه با هر درخواست به API می‌فرستد تا نشان دهد از طرف کدام حساب یا کسب‌وکار عمل می‌کند و چه کارهایی مجاز است. در نرم‌افزار حسابداری، کلید جای نام کاربری و رمز را برای اتصال‌هایی مثل فروشگاه اینترنتی، سیستم حقوق و دستمزد یا اسکریپت ثبت خودکار سند می‌گیرد.
توضیح بیشتر
کلید در سرآیند درخواست ارسال میشود، معمولاً به شکل Authorization: Bearer <key>. سرور آن را پیدا می‌کند، فعال بودن و دسترسی لازم را بررسی می‌کند و درخواست را در چارچوب کسب‌وکاری که کلید به آن تعلق دارد اجرا می‌کند.
در حسابدار من هر کلید به یک کسب‌وکار تعلق دارد و مالک آن را مدیریت می‌کند: دسترسی خواندن یا نوشتن دارد، هنگام رفتن یک همکار یا احتمال افشا قابل چرخش است و فوراً باطل میشود. هر فراخوانی با کلید مربوط در ردپای حسابرسی ثبت میشود تا معلوم باشد کدام اتصال کدام سند را ثبت کرده است.
با کلید مثل رمز عبور رفتار کنید: در متغیر محیطی یا مخزن امن نگه دارید، هرگز در کد سمت مرورگر یا مخزن عمومی نگذارید، برای هر اتصال کلید جداگانه با کمترین دسترسی لازم بسازید و کلیدها را دوره‌ای بچرخانید. راهنمای API حسابداری یک اتصال کامل را نشان می‌دهد.
مثال: ثبت سند با کلید API
فروشگاه اینترنتی پس از هر سفارش پرداخت‌شده سند فروش می‌سازد. سرور فروشگاه درخواست POST /api/v1/journal-entries را با سرآیند Authorization: Bearer <کلید فروشگاه> و Idempotency-Key: shop-order-1045 می‌فرستد. اگر کلید باطل شده باشد، پاسخ ۴۰۱ برمی‌گردد و سندی ساخته نمی‌شود.