نصب و راهاندازی
برای نصب و شروع به کار WebSDK
متریکس مراحل زیر را انجام دهید
برای نصب با استفاده از npm
دستور زیر را در پروژه خود اجرا نمایید:
npm install @metrixorg/websdk
پس از نصب با استفاده از قطعه کد زیر WebSDK
متریکس را در پروژه خود راهاندازی کنید:
import { init } from '@metrixorg/websdk';
init(APP_ID, API_KEY, config);
با استفاده از تگ
<script>
:
اگر امکان نصب با استفاده از
npm
را ندارید میتوانید تگ script
زیر را درون تگ head
پروژه خود
قرار دهید.
<script src="https://cdn.metrix.ir/sdk/web/metrix.umd-2.4.0.js"></script>
پس از افزودن script
،
برای شروع به کار WebSDK
متریکس، متد init
را به یکی از روشهای زیر فراخوانی نمایید:
typescript:
declare let Metrix: any;
Metrix.init(APP_ID, API_KEY, config);
javascript:
Metrix.init(APP_ID, API_KEY, config);
پارامترهایی که متد init
دریافت میکند به صورت جدول زیر است:
نام | type | توضیحات | اجباری |
---|---|---|---|
APP_ID | string | شناسه یکتای اپلیکیشن شما. میتوانید این شناسه را از قسمت Settings > App Info داشبورد متریکس پیدا کنید. | بله |
API_KEY | string | این کلید را از قسمت Settings > Api Key > Generate Api Key داشبورد متریکس بردارید یا جدید بسازید. | بله |
config | `O |