yougile-api-lib

Overview

The "yougile-api-lib" library is used to interact with the REST API of the YouGile platform.

Usage

All requests are sent through service instances from the

package. Services may require query parameters or a specific body-class from the

io.github.patbattb.yougileapilib.domain.body

package in arguments to serialize it into the request body. The body classes for the configuration have internal builder classes. Builders accept required arguments during initialization. Optional parameters can be added using class methods.

---

• Get the ID of the company you want to manage using the REST API (you need a username and password from your account in YouGile).

In variable

will be the companies available for managing.

You can also use web-form for getting this list.

---

• Create an API key (you need a username and password for your YouGile account and a company ID).

You can also use web-form for getting it.

After receiving the key, you can use other services to interact with the platform. For example, update the name of one of the projects:

Changelog

Can be found in CHANGELOG.

Authors

• Patrick Bates - PatBatTB

Code of Conduct

Please, follow Code of Conduct page.

License

This project is MIT License - see the LICENSE file for details