@emilgroup/public-api-sdk
v1.29.0
Published
OpenAPI client for @emilgroup/public-api-sdk
Downloads
295
Maintainers
Readme
Emil Public Api SDK
This TypeScript/JavaScript client utilizes axios. The generated module can be used with client-based applications (i.e. React).
Language level
- ES5 - you must have a Promises/A+ library installed
- ES6
Module system
- CommonJS
- ES6 module system
Although this package can be used in both TypeScript and JavaScript, it is intended to be used with TypeScript. The definition should be automatically resolved via package.json
. (Reference). For more information, you can go to Emil Api documentation.
Consuming
Navigate to the folder of your consuming project and run one of the following commands:
npm install @emilgroup/[email protected] --save
or
yarn add @emilgroup/[email protected]
And then you can import PublicApi
.
import { PublicApi } from '@emilgroup/public-api-sdk'
const publicApi = new PublicApi();
To use authentication protected endpoints, you have to first authorize. To do so, use the authorize
function in PublicApi
:
async function listDocuments(): Promise<Void> {
try {
const publicApi = new PublicApi();
await publicApi.authorize('username', 'password');
const { data: { items } } = await publicApi.listDocuments();
console.log(items);
} catch(error) {
// process error
}
}