README
Apolitical SDK
Browser library to interact with Apolitical's APIs
Requirements
Requires the following to run:
Installation
Install with yarn
:
yarn add @apolitical/sdk
Available Scripts
In the project directory, you can run:
yarn run test
Runs the test (and the interactive mode can be enabled with --watchAll
).
yarn build
Builds the library for production to the build
folder.
It correctly bundles the code on production mode and optimizes the build for the best performance.
yarn publish
Publishes the library to NPM.
Usage
The recommended way to use @apolitical/sdk
is to load the SDK first:
const loadSdk = require('@apolitical/sdk');
const sdk = loadSdk({
origin: window.origin || window.location.origin,
errorsContext: {
apiKey: decodeBase64(process.env.REACT_APP_GCP_ERRORS_API_KEY),
serviceName: 'some-service',
},
});
And then, you can use all the functionality provided by the SDK. For example:
sdk.people.users.read('me').then((result) => {
console.info('User:', result);
});