Skip to main content

Getting Started with the Web SDK

The Abowire Web SDK is a frontend library you can add to your Website to easily integrate Abowire to your business. The Web SDK includes:

  • Checkout SDK
  • Customer Portal SDK

Getting Started​

Before you get started, you will need to create a frontend API Key.

Installation​

To install the Abowire Web SDK into your Website, copy & paste the SDK's script into the <head> section of the page.

<script src="https://sdk.abowire.com/abowire.min.js"></script>
<script>
abowire.config.changeConfig({
clientId: '<your client id>',
environment: 'sandbox'
});
</script>
ParameterDescriptionIs required
clientIdYour Abowire OAuth2 Client IDRequired
environmentAbowire environment (sandbox or production)Required
sessionTokenA customer-bound Session TokenOptional
currencyCurrency ISO code (eg. EUR)Optional
localeLanguage ISO code (eg. en_UK)Optional
windowPositionPosition in which the dialog opens (left or center)Optional

Using the SDK​

After the SDK is loaded, a variable named abowire will be globally available (window.abowire).

Disable sessionStorage State Please note that the checkout saves the current state in sessionStorage. This means that if you refresh or leave and come back (given that you're using the same tab), it will resume the same state in which you left it. If you don't want this behavior, you can disable it by setting abowireDisableStorage = true before loading the SDK.

For example:

<script>
window.abowireDisableStorage = true;
</script>

<script src="https://sdk.abowire.com/abowire.min.js"></script>
<script>
abowire.config.changeConfig({
clientId: '<your client id>',
environment: 'sandbox'
});
</script>

Render the checkout inside a custom elementIf you want to render the checkout inside a custom element, you can define it usingabowireContainerId = 'myCustomDiv'` before loading the SDK.

For example:

<div id="myCustomDiv">The checkout will be rendered here</div>

<script>
window.abowireContainerId = 'myCustomDiv';
</script>

<script src="https://sdk.abowire.com/abowire.min.js"></script>
<script>
abowire.config.changeConfig({
clientId: '<your client id>',
environment: 'sandbox'
});
</script>