شروع کار › احراز هویت و کلید API

احراز هویت و کلید API

هر درخواست با کلید دسترسی شبکهٔ شما در هدر Authorization فرستاده می‌شود: Authorization: Bearer <key>. کلید را فقط از سرور خودتان بفرستید؛ هرگز در مرورگر، اپ موبایل یا مخزن کد نگذارید.

curl
curl "$RINGPAY_BASE_URL/gateway-api/v1/invoices/86Rf07xd4z" \
  -H "Authorization: Bearer $RINGPAY_API_KEY"

ساختن کلید

کلیدها را در پنل شبکهٔ پذیرنده › کلیدهای دسترسی بسازید. مقدار کلید فقط یک بار، همان لحظهٔ ساخت، نشان داده می‌شود؛ آن را در جای امنی نگه دارید. هر کلید عنوان، تاریخ انقضا (یک هفته، یک ماه، یک سال یا بدون انقضا) و فهرست اختیاری IPهای مجاز دارد. هر شبکه حداکثر ۲۰ کلید فعال می‌تواند داشته باشد.

دسترسی‌ها

هر کلید فقط یک دسترسی دارد، پس برای دو API دو کلید بسازید:

IPهای مجاز

اگر برای کلید IP تعیین کنید (حداکثر ۱۰ نشانی تکی، بدون بازه)، درخواست از هر نشانی دیگر 403 access_denied می‌گیرد. فهرست خالی یعنی هر نشانی.

خطاهای کلید

  • 401 invalid_access_key: کلید فرستاده نشده، نامعتبر است، منقضی شده یا باطل شده.
  • 403 access_denied: کلید دسترسی این API را ندارد یا از IP مجاز نیامده.

صفحه‌ها

endpointها