Vertex API Client for Java

If you're ready to integrate Vertex into your application, this is the place! For more background on the Vertex platform, start with our Developer Portal.

The Vertex REST API client for Java is generated using openapi-generator, so it's always up-to-date.

The client can be used with Java 1.8+ and pulled into Maven or Gradle projects.

Installation

Maven

<dependency>
  <groupId>com.vertexvis</groupId>
  <artifactId>api-client-java</artifactId>
  <version>0.8.3</version>
  <scope>compile</scope>
</dependency>

Gradle

compile "com.vertexvis:api-client-java:0.8.3"

Sbt

libraryDependencies += "com.vertexvis" % "api-client-java" % "0.8.3"

Others

First, generate the JAR.

mvn clean package

Then manually install the following JARs.

• target/api-client-java-0.8.3.jar
• target/lib/*.jar

Usage

If you're not an existing Vertex customer, sign up for a free account.

Export your credentials.

# Export your Vertex REST API client ID and secret
export VERTEX_CLIENT_ID=[YOUR_CLIENT_ID]
export VERTEX_CLIENT_SECRET=[YOUR_CLIENT_SECRET]

Then, check out our sample applications.

Local Development

# Version client
./scripts/bump-version.sh [patch|minor|major]

# After bumping version, generate using latest OpenAPI spec
./scripts/generate.sh