The sevdesk API SDK for JavaScript and TypeScript is an unofficial open-source API wrapper to improve interactions with the sevdesk API. It comes with preconfigured types for models, responses and request bodies.
This project is based on the official sevdesk API Documentation. If you run into any problem or if you suddenly need a error description to speed up your debug process, check their docs first.
Information that describe types, classes and type-properties are directly from the sevdesk API Documentation, where you will find further explanation. The contents have only been changes in terms of spelling corrections. All rights for the contents mentioned are reserved by sevDesk GmbH.
Install sevdesk-api-wrapper with npm or your desired node package manager:
node install sevdesk-api-wrapper yarn add sevdesk-api-wrapperTo use this package you will need a sevdesk API key. A guide on how to accquire such a key can be found here: https://api.sevdesk.de/#section/Authentication-and-Authorization
Once you have installed the package, you can go ahead and import the sevdeskAPIClient:
import sevdeskAPIClient from "sevdesk-api-wrapper";
const sevdeskAPI = new sevdeskAPIClient("your-api-key");Be aware, sevdesk API keys are regarded as secrets. It is adwised to save them in a .env file for some other form of save key-storage and not directly inside of your active codebase.
Contributions are always welcome!
This is my first API SDK, so a learn-by-doing type of solution. If you have any ideas for better maintainablity, readablity or the code in general, feel free to make a Pull Request.
See contributing.md for ways to get started.
Please adhere to this project's code of conduct.
As already stated, this project is not maintained nor funded by sevDesk GmbH or any associated company/organization. It is also not made to generate profits are be monetized in any way.
![@dependabot[bot]](https://avatars.githubusercontent.com/in/29110?s=64&v=4){kind=small}