@dintero/discounts-web-sdk

Dintero Discounts JavaScript SDK for frontend applications

Use this SDK in your frontend application to embed one or more discounts from the Dintero Discount Service service in your webpage.

Learn more about the Dintero Discount Service at docs.dintero.com

Installation

NPM package

npm install @dintero/discounts-web-sdk

Inline HTML JavaScript example getting a list of discounts with API access

In this example the SDK will try to fetch data from the discount service.

Make sure to configure the plugin with an API client that only has grants giving access to the public:discounts scope.

<script type="text/javascript">
    const container = document.getElementById("checkout-container");
    discounts.embed({
        container: document.getElementById("deals-container"),
        api: {
            account: "P00000000",
            key: "public_api_key",
            secret: "abcdef01-2345-6789-abcd-ef0123456789",
        },
        theme: {
            fontSize: "14px",
            color: "rgba(0,0,0,1)",
            primary: "hotpink",
            secondary: "aqua",
            background: "#fff",
        },
    });
</script>

Inline HTML JavaScript example getting a single discounts with API access

In this example the SDK will try to fetch data from the discount service for a given discountId.

Make sure to configure the plugin with an API client that only has grants giving access to the public:discounts-scope.

<script type="text/javascript">
    const container = document.getElementById("checkout-container");
    discounts.embed({
        container: document.getElementById("deals-container"),
        api: {
            account: "P00000000",
            key: "public_api_key",
            secret: "abcdef01-2345-6789-abcd-ef0123456789",
            discountId: "1234",
        },
        theme: {
            fontSize: "14px",
            color: "rgba(0,0,0,1)",
            primary: "hotpink",
            secondary: "aqua",
            background: "#fff",
        },
    });
</script>

Inline HTML JavaScript example with discount objects

In this example the SDK is supplied with a list of discount objects directly.

<script type="text/javascript">
    const container = document.getElementById("checkout-container");
    discounts.embed({
        container: document.getElementById("deals-container"),
        theme: {
            fontSize: "14px",
            color: "rgba(0,0,0,1)",
            primary: "hotpink",
            secondary: "aqua",
            background: "#fff",
        },
        discounts: [
            {
                id: "1",
                name: "Testvare",
                description: "Beskrivelse av testvare",
                requirement: {
                    item: { items: [{ id: "testvare-1" }] },
                    customer: {},
                    store_ids: ["*"],
                    purchase_to: "2030-06-13T21:59:00Z",
                    purchase_from: "2080-06-06T22:00:00Z",
                },
                limitation: {},
                reward: { type: "discount_item_new_price", value: 5000 },
                created_by: "DinteroTest",
                created_at: "2021-06-04T10:21:18.029Z",
                updated_at: "2021-06-04T10:21:18.029Z",
                receipt_text: "Ukens tilbud",
                type: "item",
                links: [
                    {
                        rel: "medium_discount_image",
                        href: "https://uploads-ssl.webflow.com/5f023ba9549ac22870f32943/5f1333ae5a496b0e0476975e_dintero-logo.svg",
                    },
                ],
                metadata: {
                    label: "Før: 100,-",
                    subtitle: "Ukens tilbud",
                    campaign_id: 1,
                },
                active: true,
            },
        ],
    });
</script>

Inline HTML JavaScript example with discount webshop links and their link behaviour

In this example the SDK will try to fetch data from the discount service with webshop links.

The behaviour of opening links can be adjusted using linkTarget in the configuration.

_self (default) will open the webshop link directly on the same tab.

_blank will open the webshop link in a new tab.

<script type="text/javascript">
    const container = document.getElementById("checkout-container");
    discounts.embed({
        container: document.getElementById("deals-container"),
        linkTarget: '_blank'
        api:{
            account: 'P00000000',
            key: 'public_api_key',
            secret: 'abcdef01-2345-6789-abcd-ef0123456789',
        },
        theme: {
            fontSize: "14px",
            color: "rgba(0,0,0,1)",
            primary: "hotpink",
            secondary: "aqua",
            background: "#fff",
        }
    });
</script>

Bugs

Bugs can be reported to https://github.com/Dintero/Dintero.Discounts.Web.SDK/issues

Security

Contact us at [e-mail]

Browser support

All major modern browsers above version N - 1, where N is the most recent version.

Building from source

yarn install
yarn run build

Creating a new release

1. Enforce all commits to the master branch to be formatted according to the Angular Commit Message Format
2. When merged to master, it will automatically be released with semantic-release