Search Results for ""

S2S Integration

یکپارچه سازی سرور با سرور

۱. این API این امکان را به شما می‌دهد که رخداد‌هایی که در داخل App یا خارج از آن رخ می‌دهد اما توسط SDK ارسال نمی‌شود را از طریق سرور‌های خود برای ما ارسال کنید. برای این منظور می‌توانید از API زیر استفاده کنید

1
2
3
Method: POST

URL: "http://analytics.metrix.ir/inappevent/{appId}"

appId: همان کلید اپلیکیشن شماست که از پنل متریکس آن را دریافت می‌کنید
برای پیدا کردن appId برنامه‌ی مورد نظر خود می‌توانید به صفحه‌ی سازمان آن مراجعه کنید و در بخش Apps آن را ‌copy کنید.

1
2
3
4
Path Variable:
{
	"appId": {app-id}
}

این بخش توسط سیستم برای هر App تولید می‌شود. کافی است با مراجعه به صفحه‌ی تنظیمات App در بخش Advanced Settings کلید(dev-key) را Copy کنید.

همچنین برای امنیت بیشتر داده‌های دریافتی می‌توانید در قسمت Advanced Settings در هر App لیستی از ip های مورد تائید خود را وارد کنید تا تنها رخدادهای دریافتی از آن محل معتبر شمرده شوند.

1
2
3
4
Request Header:
{
	"Authorization":  {dev-key},
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
Request Body:
{
  "metrixUserId": {Metrix User ID },        // e.g. 1415211453000-6513894
  "metrixSessionId": {Metrix Session ID },

  "idfa":{idfa},                            // for ios
  "advertisingId":{Google advertising id},  // for Android

  "customAttributes": {     // A JSON containing a rich in-app event value - must be String to String},
  {
    "content_type": "wallets",
    "content_id": "hrhfwbrfybwa"

  },
  "customMetrics": {        // A JSON containing a rich in-app event value - must be String to Double},
  {
    "revenue": 130.5
  },

  "deviceIp": {device IP},
  "eventSlug": {The event slug},            // e.g. "taqsq"
  "eventTime": {Event timestamp in UTC +0}, // e.g "1570274953412" timestamp in millisecond
}

پارامترها

تمام پارامتر‌‌هایی که در Header و URL وجود دارند ضروری محسوب می‌شود و به هنگام استفاده از این API باید وارد شوند.

پارامترهای اجباری

  • metrixUserId
  • metrixSessionId
  • advertisingId or idfa : همان طور که می‌دانید idfa برای دستگاه‌هایی با سیستم عامل ios و advertisingId برای Android است. با توجه به نوع دستگاهی که رخداد مورد نظر شما در آن اتفاق می‌افتد باید دقیقا یکی از آن‌ها را انتخاب و داده‌ی متناظر با آن را وارد کنید. انتخاب هر دوی آن‌ها یا هیچ‌کدام از آن‌ها باعث 400 Bad Request می شود.

  • eventSlug همان slug مشخص شده در حین تعریف یک رخداد در داشبورد متریکس است.

  • eventTime زمانی که رخداد در App اتفاق می‌افتد. در صورتی که این زمان وارد نشود، زمان آن لحظه از سیستم که رخداد دریافت می‌شود به عنوان زمان وقوع رخداد ثبت می‌شود.

پارامترهای اختیاری

  • customAttributes توسط این پارامتر می‌توانید اطلاعات دلخواه خود را ارسال کنید. اطلاعات ارسالی در این بخش یک Json است که تمامی value های آن باید رشته (String) باشند.
  • customMetrics توسط این پارامتر می‌توانید اطلاعات دلخواه خود را ارسال کنید. اطلاعات ارسالی در این بخش یک Json است که تمامی value های آن باید عدد (Double) باشند.
  • deviceIp توسط این پارامتر آدرس ip دستگاه را می‌توانید ارسال کنید.