# @optimizely/optimizely-connector

> A connector is an interface that connects your application to external/third-parrty providers. Adding the Optimizely connector to your application will allow you to connect an existing Optimizely account to your application and will allow you set up and r

Latest version **1.0.17** (published 2020-12-03) · SEE LICENSE IN LICENSE.md license · 0 weekly downloads

## Install

```sh
npm install @optimizely/optimizely-connector
pnpm add @optimizely/optimizely-connector
yarn add @optimizely/optimizely-connector
bun add @optimizely/optimizely-connector
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.17 |
| Published | 2020-12-03 |
| First published | 2020-12-03 |
| Weekly downloads | 0 |
| License | SEE LICENSE IN LICENSE.md |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >= 10.x.x |
| Dependencies | 2 |
| Unpacked size | 106.5 KB |
| Known vulnerabilities | 0 (+25 in 1 direct dependencies) |
| Install scripts | no |
| Maintainers | optimizely-fullstack |

## Links

- npm: https://www.npmjs.com/package/@optimizely/optimizely-connector
- npm.io page: https://npm.io/package/@optimizely/optimizely-connector

## Dependencies (2)

- [axios](https://npm.io/package/axios.md) 0.21.0
- [@optimizely/optimizely-sdk](https://npm.io/package/@optimizely/optimizely-sdk.md) ^4.0.0

## Recent versions

- 1.0.17 (latest) — 2020-12-03

## README

A connector is an interface that connects your application to external/third-parrty providers.
Adding the Optimizely connector to your application will allow you to connect an existing Optimizely account
to your application and will allow you set up and run experiments on your pages

**Note: Before Adding**

To use the Node Optimizely Connector v1.0 you will have to deploy the Optimizely Retail Server Extension to your Retail Server.
The extension will expose a new endpoint on your Retail Server which the Node connector will use to fetch the list of experiments

[Read here for detailed documentation on the Optimizely Retail Server Extension.](../ExperimentsExtension_README.md)


Future versions (v2.0) and greater of the optimizely-connector requires your Retail Server version to be 10.0.14 or greater and corresponding retail-server-proxy to be 9.24.2 or greater.

**Setting up your Connector Settings**

The connector requires the following config information in connector.settings.json (found under src/settings)

1) sdkKey: A sdkKey is a key associated with an environment in the project to instantiate a client. This information is requried.

2) refreshTime: refresh time controls the update interval of the Optimizely SDK how often to poll for the latest changes made to your features 
is measured in seconds. The refreshTime should match the cache settings provided for the datafile to keep your server and client instances in sync.

3) projectId: The project id of your Optimizely project

4) oun: The operating unit number of the online store. This is used to retrieve the opttimizely access token from the Key Vault.

**Provisioning an Optimizely API Access Token in Retail Server**

Along with configuring the above in your connector.settings.json you will also need to create a secret key with the name 'OptimizelyAccessToken' in your Retail Server keyvault.
The value should be a valid Optimizely personal API access token, that can make requests to the project id being used.

---
_Source: https://npm.io/package/@optimizely/optimizely-connector · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._