/reference-client-move

A reference client implementation for eCG Motors Vertical

Primary LanguageJavaMIT LicenseMIT

License: MIT

Reference Client for MoVe Listing API

If you are planning to integrate with eCG Motors Vertical (MoVe) and are interested in technical details around Listing API usage, this project is for you.

This repository contains a reference client implementation for the MoVe Listing API. It uses a simple Java Jersey client doing REST calls, which aims to be as simple and readable as possible.

What's in the box

This repository contains 2 parts:

  1. a reference API client written in basic Java with JaxRs/Jersey
  2. a number of tests that cover common usage scenarios

To inspect the implementation, run ./gradlew clean compileJava first to generate necessary client classes out of MoVe's Listing API spec. Feel free to create own clients based on this spec as it fits your needs.

How to run the tests

To run the scenario tests on the other hand, you need 2 things:

  1. credentials for the MoVe sandbox environment, and an assigned partnerId. If you haven't received those, please reach out to MoVe. Once you have these details, set them in config.properties.
  2. MoVe only allows access to public APIs from well-known, whitelisted IPs, so you need to provide one or more for your organisation. When running the contained tests, make sure your machine utilizes a whitelisted IP.

Once all mentioned preconditions have been addressed, run ./gradlew clean test and ensure that the tests are green. Next feel free to check the implementation itself and see how the common usage scenarios can be implemented.