کلیدهای API

دو اعتبارنامه با نقش‌های جداگانه برای runtime و فرآیند build.

پس از ساخت پروژه در app.didban.cloud، از Settings → API Keys کلید موردنیاز را ایجاد کنید. مقدار کامل هر کلید تنها هنگام ایجاد نمایش داده می‌شود؛ آن را در محل امن نگه دارید.

کلیداستفادهکاربرد
didban_ing_...اپلیکیشن نصب‌شدهارسال رخدادهای کرش و session
didban_build_...Gradle / CIبارگذاری R8 mapping و native symbols

کلید Runtime Ingestion

این کلید را در اندروید به Didban.init و در iOS به Didban.initialize می‌دهید. چون SDK در اپلیکیشن کاربر اجرا می‌شود، این یک credential سمت کلاینت با دسترسی محدود به ingestion است؛ credential ورود به داشبورد نیست و اجازه بارگذاری artifact ساخت را ندارد.

MyApp.kt (Android)kotlin
Didban.init(
    context = this,
    apiKey = "didban_ing_your_key"
)
MyApp.swift (iOS)swift
Didban.initialize(apiKey: "didban_ing_your_key")

کلید خالی باعث می‌شود init بدون اقدام بازگردد. کلید نامعتبر یا باطل‌شده در زمان upload پذیرفته نمی‌شود؛ رخداد pending تا اجرای بعدی باقی می‌ماند.

کلید Build / CI

این کلید فقط به Gradle plugin در ماشین توسعه یا CI داده می‌شود. هرگز آن را در source، resources، manifest، BuildConfig یا APK/AAB قرار ندهید.

app/build.gradle.ktskotlin
didban {
    authToken.set(providers.gradleProperty("DIDBAN_BUILD_API_KEY"))
}

برای CI، مقدار را از secret store به Gradle property یا environment variable وارد کنید. برای کار محلی، یک gradle.properties خارج از کنترل نسخه (یا فایل user Gradle) مناسب است.

هشدار امنیتی

کلیدها قابل‌جایگزینی نیستند. plugin فقط مقدارهایی با پیشوند didban_build_ را برای upload در نظر می‌گیرد؛ کلید Ingestion باعث skip شدن upload بدون درخواست شبکه می‌شود.

دیدبان — پلتفرم بومی مانیتورینگ و گزارش کرش اپلیکیشن‌های موبایل.