exoplatform-api-wrapper
A wrapper for the API of the Open source Enterprise Social Network of eXo Platform. It covers the Social REST API, which is badly documented.
It is entirely built from TypeScript and fully tested. API responses are typed, so you can get full auto-completion in your code editor.
This project is dependency-free.
Install
yarn add exoplatform-api-wrapper# or npm i exoplatform-api-wrapper
Usage
The example below shows how to get activities available in a user's feed.
  setup
Documentation
See rigwild.github.io/exoplatform-api-wrapper.
Full API coverage/example is available in the automated tests: ./test/tests.ts
.
Running tests
You must configure the tests by setting the following environment variables.
Environment variable | Description | Required | Default | Example |
---|---|---|---|---|
EXO_HOSTNAME |
eXo Platform social network hostname (no protocol://) | â | www.example.com |
|
EXO_PATH |
eXo Platform API path | â | /rest |
/exo/platform/rest |
EXO_USERNAME |
eXo Platform account username | â | myUser |
|
EXO_PASSWORD |
eXo Platform account password | â | myPassword |
|
EXO_SECURE_PROTOCOL |
SSL protocol to use (do not touch if you don't know what it is!!) | â | undefined |
TLSv1_method |
EXO_CIPHERS |
SSL ciphers to use (do not touch if you don't know what it is!!) | â | undefined |
AES128-SHA |
Then, you can run the tests:
yarn test# or npm run test
Notice
The author of this library is not affiliated in any way with eXo Platform.
Contributing
If you found a bug or want any features not available yet, feel free to open an issue documentating the problem.
You may also contribute to the project by opening a Pull Request.