Skip to content
DevelopmentJavaScript
About
Getting StartedContributing
Usage
AccountsAPI TokensAuthBusinessesBusiness InvitesEventsGraphQLGroupsMailboxesProductsInstancesStagesTemplatesTransitionsTranslationsUsersNetwork Connections
Architecture
AuthenticationSingletonsHTTP RequestsGraphQL
Development
API ClassesConfigurationEventsLoggingModelsUtilities
Documentation
Getting StartedContributingTechnical ComponentsStructureFirst Party ComponentsRecipe - Adding a PageRecipe - Adding Links
Tooling
BuildCoverageDebuggingLintingTesting
GitHub

Getting Started

Table of contents
Table of contents

Installation

XEDI.js is currently published to the GitHub Package Repository. You can find out more about the GitHub Package Repository here.

Using NPM

npm install @xedi/sdk-js

XEDI.js also ships with TypeScript typings!

Configuration

You can configure the SDK using the Xedi.Config class. This class extends a JavaScript Map object, so the usual get, set, and delete methods will work as per the original object. For example, you can configure which base_url should be used to contact a API Gateway instance.

Xedi.Config.set('base_url', 'https://api.staging.xedi.com');

Below you will find a list of all configurations.

ConfigurationDefault ValueComments
base_urlhttps://api.xedi.com
refresh_tokenSet and managed by Xedi.Auth
access_tokenSet and managed by Xedi.Auth
modeproduction

Learn more about using the Xedi.Config class here.

Edit this page on GitHub
1 contributorSmudge3806
Last edited by Smudge3806 on June 22, 2020