Widget Creation
Given below are the integration steps to embed the widget in your website.
Web Widget integration involves the inclusion of three HTML tag.
1.JS File
Note: Don't forget to change url in production to https://platform.onmeta.in/onmeta-sdk.js
2. Widget Location
3. Initialiser file (Base)
Parameter | Sample Value | Remarks |
elementId | "widget" | Mandatory (It should be an id of an element not a class), the name given in step 2 for id |
apiKey | "{api_key}" | Mandatory, this you will get from dashboard post registration |
walletAddress | "0xEcc24eab0fb83Ef0c536b35C44C578F750FDBB6E" | Optional , the wallet address to which tokens to be transferred. |
fiatAmount | "100" | Optional , the amount for which you need to buy token. |
userEmail | "test@test.com" | Optional , the email ID of the user. |
chainId | "80001" | Optional, the block chain ID in which the token is present. example: 80001 for polygon testnet |
tokenAddress | "0xEcc24eab0fb83Ef0c536b35C44C578F750FDBB6E" | Optional, the address for the required token, this can be fetched from respective chains data. |
Note: By default widget will be initialised with OnRamp functionalities only.
Widget initialisation happens when you call createWidget.init(); and all the respective events are notified back to the parent and once can handle event based actions respectively by passing the callbackFn names to the events like this createWidget.on(eventType, callbackFn);
callbackFn - Its the function you have to pass along with the eventType. This function will get called when the event is fired.
Events | Description |
ALL_EVENTS | this will listen to all the events of the widget and notify the callback function once event is triggered. |
SUCCESS | this will listen to the success event of the widget |
FAILED | this will listen to the failed event of the widget. |
ORDER_EVENTS | this will listen to the order related events. |
ORDER_COMPLETED_EVENTS | this will listen to order completed events. |
ACTION_EVENTS | this will listen to action events. |