RNV-API

Java-based client implementation of the RNV (Rhein-Neckar-Verkehr) API.

You can find the complete documentation and request an API token on the OpenData Portal of Rhein-Neckar-Verkehr.

---

Installation

You can either download the latest version and add the .jar file to your project libraries, or install the downloaded artifact to your repository and let one of the following build and dependency management tools take care for you:

Maven (pom.xml)

Add the dependency:

<dependencies>
    <dependency>
        <groupId>io.github.krymonota</groupId>
        <artifactId>rnv-api</artifactId>
        <version>1.1.0</version>
    </dependency>
</dependencies>

Gradle (build.gradle)

Add the dependency:

dependencies {
    implementation 'io.github.krymonota:rnv-api:1.1.0'
}

sbt (build.sbt)

Add the dependency:

libraryDependencies += "io.github.krymonota" % "rnv-api" % "1.1.0" 

---

Getting Started

First you need an API token, which can be requested on the OpenData Portal of Rhein-Neckar-Verkehr.

After you've received an API token by email, you can start by creating an instance of RNVAPIService by calling RNVAPI#createAPIServiceProvider and passing the API token as a parameter. Then you can collect all desired information by calling the API methods in the RNVAPIService interface.

For more information on calling these API methods, take a look at the examples and unit tests.

---

Interfaces

• Station Package
• Line Package
• Station Monitor
• Line Journey
• Station Info
• Journey Info
• News
• Ticker
• Canceled Lines

---

Dependencies (Maven)

Libraries and tools that are used to build this project:

• Project Lombok
• Retrofit
• Gson / Gson-Converter for Retrofit
• JUnit
• Checkstyle

---

License

This project is licensed under the Apache License, Version 2.0. See the LICENSE file for details.