Enium Portal Partner API Documentation

Welcome to the Enium Portal Partner API documentation. This repository houses the documentation for the Enium Portal Partner API, built with Docusaurus. Our API empowers partners to integrate efficiently with the Enium Portal, offering a range of functionalities from data retrieval to complex operations.

Getting Started

Prerequisites

Before beginning, make sure you have the following installed:

• Node.js (version 18.0 or newer)
• npm or Yarn

Installation

To get started, clone the repository and install the dependencies:

git clone https://github.com/ElementsCapitalGroup/portal-api-documentation
cd portal-api-documentation
npx install # or yarn install

Running the Documentation Locally

To start the development server:

npx docusaurus start # or yarn start

This command will launch a local server and open up a browser window. Most changes are reflected live without having to restart the server.

Documentation Structure

The documentation is organized into several key sections:

• Getting Started: Basic information on how to begin using the Enium Portal Partner API.
• API Reference: Comprehensive description of the API endpoints, parameters, and expected responses.
• Guides and Tutorials: Step-by-step guides and tutorials for common use cases and integrations.
• FAQs: Answers to frequently asked questions.
• Changelog: Updates and changes to the API.

Contributing

Contributions to the Enium Portal Partner API documentation are welcome.

Support

For issues or questions, please file an issue on the GitHub issue tracker.

License

This project is licensed under the MIT License.