@charma/js
v1.1.0
Published
Charma Widget
Downloads
425
Readme
How to use
Authentication
The Charma API uses API keys to authenticate requests. You can view and manage your API keys in the Charma Portal. Your API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth. User of API key as Bearer token
{
headers: {
Authorization: 'Bearer YOUR_API_KEY';
}
}Usage of API key as query param:
curl --request GET \\
-- url 'https://api.charma.io/v1/categories?apiKey=YOUR_API_KEY \\
-- header 'Content-Type: application/json'Installation
First, you need to install the Gifting Widget package in your application:
npm install @charma/jsInitialization
Next step is to initialize the widget and API:
import { widget } from '@charma/js';
import { defineCustomElements } from '@charma/js/loader';
defineCustomElements();
widget.init(
'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJvcmdJZCI6ImRhc2QtZmRmc2ZkLWFzZGFhc2QtZXFlLWFkc2FkIiwiaWF0IjoxNjc1MDE2MjIxLCJleHAiOjE2NzUwMTYyODF9.N87e7y9fajSt5LrtQBe3R0sJ1I2_N2gKqN1Eun2mVak',
);Usage
<html>
<body>
<charma-widget></charma-widget>
</body>
</html>