Skip to content

Latest commit

 

History

History
63 lines (46 loc) · 2.69 KB

README.md

File metadata and controls

63 lines (46 loc) · 2.69 KB

Metaco API Java client Build Status

Metaco REST API provides a set of services to integrate Metaco into third-party applications. It offers trading and payment facilities as well as wallet management features.

Our Java Client implements every single functionality of the API. You can find a detailed documentation here : API Documentation, and the javadoc here : JavaDoc

Installation

Using Maven

Add the following dependency to your project's Maven pom.xml:

<dependency>
	<groupId>com.metaco.api</groupId>
	<artifactId>metaco-java-client</artifactId>
	<version>1.1.1</version>
</dependency>

Manual

Our latest releases should also be available on the Github releases. You can download our JAR file here.

You will also need to manually install those dependencies :

Usage

You can use our Unit tests to learn the basics or the links in the summary of this document.

Testing

The tests requires a testnet environnement to work.

Define the following environment variables :

  • METACO_ENV_API_ID : Your testnet API ID
  • METACO_ENV_API_KEY : Your testnet API Key
  • METACO_ENV_API_URL : http://api.testnet.metaco.com/v1/ (Or the endpoint you want to run your tests with)
  • METACO_ENV_WALLET_PRIVATE_KEY_HEX : The private key of your testnet wallet (hex-encoded)

Run mvn clean test

Contributing

  1. Fork this repository and make your changes in your fork
  2. Add or Update the tests and run mvn clean test to make sure they pass
  3. Commit and push your changes to your fork git push origin master
  4. Submit a pull request and we will handle the rest :)

Known Issues / Gotcha

  • The api is still unstable.

License

MIT (See LICENSE).