Using client classes makes it easier and more convenient to integrate the API into an existing programming environment. We provide here clients for Java, C# and TypeScript. Alternatively you can generate the clients yourself by using this tutorial.
Language depending information:
-
DotNet: Please add the following nuget packages to your client project
- Please use .NET 6.0
- JsonSubTypes (1.8.0)
- Polly (7.2.3)
- RestSharp (106.13.0)
- System.ComponentModel.Annotations (5.0.0)
To initialize your client with your APIKey you can use the following snippet:
var apiKey = new Dictionary<string, string>(){["apiKey"] = "Enter your ApiKey here" }; var configuration = new Configuration() { ApiKey = apiKey }; MatricesApi matricesApi = new MatricesApi(configuration);
-
Java: Please add the following dependencies to your project
<dependency> <groupId>com.fasterxml.jackson.core</groupId> <artifactId>jackson-core</artifactId> <version>2.10.4</version> </dependency> <dependency> <groupId>com.fasterxml.jackson.core</groupId> <artifactId>jackson-annotations</artifactId> <version>2.10.4</version> </dependency> <dependency> <groupId>com.fasterxml.jackson.core</groupId> <artifactId>jackson-databind</artifactId> <version>2.10.4</version> </dependency> <dependency> <groupId>com.fasterxml.jackson.datatype</groupId> <artifactId>jackson-datatype-jsr310</artifactId> <version>2.10.4</version> </dependency> <dependency> <groupId>org.openapitools</groupId> <artifactId>jackson-databind-nullable</artifactId> <version>0.2.1</version> </dependency> <dependency> <groupId>com.github.ptv-logistics</groupId> <artifactId>openapi-generator-cli</artifactId> <version>6.2.1</version> </dependency> <dependency> <groupId>javax.ws.rs</groupId> <artifactId>javax.ws.rs-api</artifactId> <version>2.1.1</version> </dependency>
To initialize your client with your APIKey you can use the following snippet:
ApiClient apiClient = Configuration.getDefaultApiClient() .setRequestInterceptor(builder -> builder.setHeader("ApiKey", "Enter your ApiKey here")); MatricesApi matricesApi = new MatricesApi(apiClient);
-
TypeScript: Please add the following dependencies to your project
- nodeVersion (18.14.0)
- aurelia-api (3.2.1)
- aurelia-fetch-client (1.8.2)
- node-fetch (2.6.2)
- polly-js (1.8.0)
- typescript (4.9.5)
- typescript-http-client (0.10.4)
- @types/node-fetch (2.6.2)
To initialize your client with your APIKey you can use the following snippet:
let configurationParameters: ConfigurationParameters = {fetchApi: require('node-fetch'), headers: {ApiKey: "Enter your ApiKey here"}}; let configuration: Configuration = new Configuration(configurationParameters); let matricesApi: MatricesApi = new MatricesApi(configuration);
Please refer to our Matrix Routing API documentation.