{"id":16095648,"url":"https://github.com/rigwild/exoplatform-api-wrapper","last_synced_at":"2025-07-29T15:15:26.063Z","repository":{"id":115713087,"uuid":"194740113","full_name":"rigwild/exoplatform-api-wrapper","owner":"rigwild","description":"An eXo Platform Social REST API wrapper 🧐","archived":false,"fork":false,"pushed_at":"2020-07-08T17:33:34.000Z","size":550,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-07-14T03:03:17.508Z","etag":null,"topics":["api-wrapper","exo-platform"],"latest_commit_sha":null,"homepage":"https://rigwild.github.io/exoplatform-api-wrapper/classes/_exoplatformwrapper_.exoplatformwrapper","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rigwild.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-07-01T20:41:31.000Z","updated_at":"2022-03-06T17:24:05.000Z","dependencies_parsed_at":"2023-04-17T20:32:38.318Z","dependency_job_id":null,"html_url":"https://github.com/rigwild/exoplatform-api-wrapper","commit_stats":{"total_commits":25,"total_committers":3,"mean_commits":8.333333333333334,"dds":0.07999999999999996,"last_synced_commit":"64f53e8e825a7904cdd04ba5b3c1b84df6d0521b"},"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"purl":"pkg:github/rigwild/exoplatform-api-wrapper","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rigwild%2Fexoplatform-api-wrapper","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rigwild%2Fexoplatform-api-wrapper/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rigwild%2Fexoplatform-api-wrapper/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rigwild%2Fexoplatform-api-wrapper/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rigwild","download_url":"https://codeload.github.com/rigwild/exoplatform-api-wrapper/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rigwild%2Fexoplatform-api-wrapper/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":267706922,"owners_count":24131266,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-07-29T02:00:12.549Z","response_time":2574,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api-wrapper","exo-platform"],"created_at":"2024-10-09T17:07:26.631Z","updated_at":"2025-07-29T15:15:26.035Z","avatar_url":"https://github.com/rigwild.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# exoplatform-api-wrapper\n\n[![npm badge](https://img.shields.io/npm/v/exoplatform-api-wrapper.svg?logo=npm)](https://www.npmjs.com/package/exoplatform-api-wrapper)\n[![Build Status](https://travis-ci.org/rigwild/exoplatform-api-wrapper.svg?branch=master)](https://travis-ci.org/rigwild/exoplatform-api-wrapper)\n\nA wrapper for the API of the [Open source Enterprise Social Network](https://www.exoplatform.com/enterprise-social-network/) of [eXo Platform](https://www.exoplatform.com/). It covers the [Social REST API](https://docs-old.exoplatform.org/public/index.jsp?topic=%2FPLF43%2FPLFDevGuide.eXoPlatformAPIs.RestAPIs.Social.DataModels.Activity.html), which is badly documented.\n\nIt is entirely built from TypeScript and fully tested. API responses are typed, so you can get full auto-completion in your code editor.\n\nThis project is dependency-free.\n\n## Install\n```sh\nyarn add exoplatform-api-wrapper\n# or\nnpm i exoplatform-api-wrapper\n```\n\n## Usage\nThe example below shows how to get activities available in a user's feed.\n```ts\nimport ExoPlatformWrapper from 'exoplatform-api-wrapper'\n\nconst setup = async () =\u003e {\n  const exoWrapper = new ExoPlatformWrapper('www.example.com')\n  await exoWrapper.login('myUsername', 'myPassword')\n  const { activities } = await exoWrapper.user.readStream()\n  console.log(activities)\n}\n\nsetup()\n```\n\n## Documentation\nSee [rigwild.github.io/exoplatform-api-wrapper](https://rigwild.github.io/exoplatform-api-wrapper/classes/_exoplatformwrapper_.exoplatformwrapper).\n\nFull API coverage/example is available in the automated tests: [`./test/tests.ts`](./test/tests.ts#L45-L9999).\n\n## Running tests\nYou must configure the tests by setting the following environment variables.\n\n| Environment variable | Description | Required | Default | Example |\n| -------------------- | ----------- | :------: | ------- | ------- |\n| `EXO_HOSTNAME` | eXo Platform social network hostname (no protocol://) | ✅ ||`www.example.com` |\n| `EXO_PATH` | eXo Platform API path | ❌ | `/rest` | `/exo/platform/rest` |\n| `EXO_USERNAME` | eXo Platform account username | ✅ || `myUser` |\n| `EXO_PASSWORD` | eXo Platform account password | ✅ || `myPassword` |\n| `EXO_SECURE_PROTOCOL` | SSL protocol to use (do not touch if you don't know what it is!!) | ❌ | `undefined` | `TLSv1_method` |\n| `EXO_CIPHERS` | SSL ciphers to use (do not touch if you don't know what it is!!) | ❌ | `undefined` | `AES128-SHA` |\n\nThen, you can run the tests:\n```sh\nyarn test\n# or\nnpm run test\n```\n\n## Notice\nThe author of this library is not affiliated in any way with eXo Platform.\n\n## Contributing\nIf you found a bug or want any features not available yet, feel free to open an [issue](https://github.com/rigwild/exoplatform-api-wrapper/issues) documentating the problem.\n\nYou may also contribute to the project by opening a [Pull Request](https://github.com/rigwild/exoplatform-api-wrapper/pulls).\n\n## License\n[The MIT license](./LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frigwild%2Fexoplatform-api-wrapper","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frigwild%2Fexoplatform-api-wrapper","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frigwild%2Fexoplatform-api-wrapper/lists"}