API key یعنی چه؟
تلفظ: اِیپیآی کی · نوع: اسم
معنی API key: کلید API؛ رمزی که برنامهی تو را به سرویس میشناساند
key یعنی کلید. API key رشتهای بلند و تصادفی است که وقتی در یک سرویس ثبتنام میکنی به تو میدهند و برنامهات آن را با هر درخواست میفرستد. سرویس با آن میفهمد درخواست از طرف کدام مشتری است، چند بار صدایش زدهای و اجازهی چه کارهایی را داری. مثل کارت عضویت کتابخانه: بدون آن کتاب نمیدهند و هر چه بگیری به حساب تو نوشته میشود. فرقش با access token این است که کلید معمولاً مال برنامه است و عمرش طولانی؛ توکن مال یک کاربرِ واردشده است و زود باطل میشود.
API key در جمله
Never commit your API key to a public repository.
هیچوقت کلید API خودت را در یک مخزن عمومی کامیت نکن.
API key در کد
import os, requests
key = os.environ["WEATHER_API_KEY"]
r = requests.get("https://api.example.com/weather", headers={"X-API-Key": key})کلید از متغیر محیطی خوانده میشود، نه این که داخل کد نوشته شده باشد.
نکته
کلید را مثل رمز عبور نگه دار. اگر لو رفت، از پنل همان سرویس باطلش کن (revoke) و یک کلید تازه بساز.
کلمههای مرتبط
- secret: راز؛ هر مقدار محرمانه مثل رمز و کلید
- access token: توکن دسترسی؛ بلیت موقت کار با API
- environment variable: متغیر محیطی؛ مقداری که سیستم به برنامه میدهد
درس این کلمه
API key یکی از هشت کلمهی درس «کلید و محدودیت» در فاز 4: وب و API از دورهی انگلیسی برای برنامهنویسها است. بقیهی کلمههای این درس:
- secret: راز؛ هر مقدار محرمانه مثل رمز و کلید
- rate limit: سقف تعداد درخواست در یک بازهی زمانی
- quota: سهمیه؛ مقدار کل مجاز در یک دوره
- webhook: نشانیای که سرویس دیگر هنگام یک اتفاق خودش صدا میزند
- callback: تابعی که میدهی تا بعداً صدایش بزنند
- SDK: بستهی آمادهی ابزار و کد برای کار با یک سرویس
- sandbox: محیط آزمایشی و جدا، بدون خطر برای چیزهای واقعی