---
slug: overview
---

# Experience App SDK

## Introduction

The Experience App SDK is a typescript library to help you utilize ShowpadJS in
your experience apps.

## Requirements

**Development**

- HTML & JavaScript knowledge
- a Code Editor (we like [Visual Studio Code](https://code.visualstudio.com/))
- [Node.js 15+](https://nodejs.org/en/)

**Showpad**

- Ultimate subscription to Showpad
- Administrator access to Showpad's Online Platform

## Platform & Browser Compatibility

> **@next versions**: Versions tagged with --next might contain small issues.
> Only use in production if you can alter the .Showpad package quickly.

### Development

You can run your extension point from localhost in latest Chrome, Firefox, Edge
& Safari.

### Production

|             |  WEB  |  iOS  | Android | Windows |
| ----------- | :---: | :---: | :-----: | :-----: |
| SDK Version | 3.0.0 | 3.0.0 |  3.0.0  |  3.0.0  |

> **Showpad Experience Apps run inside Iframes**: Use relative paths in
> production.

> **The Experience App SDK targets ES2022**: Transpile your code if you need
> legacy support.

## Installation

```shell
# npm
npm i @showpad/experience-app-sdk

# yarn
yarn add @showpad/experience-app-sdk
```

## Usage

```ts
import { Showpad } from '@showpad/experience-app-sdk';

const main = async (): Promise<void> => {
  // Always wait for ShowpadLib to be loaded
  await Showpad.onShowpadLibLoaded();

  const userInfo = await Showpad.getUserInfo();
  const deviceInfo = await Showpad.getDeviceInfo();
};

main();
```

## Documentation

You can find documentation on the
[Showpad Developer Portal](https://developer.showpad.com/docs/appsv2/developer-tools/sdk).