Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 27 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,35 @@
# Dyspatch Java API client
# dyspatch-java

Dyspatch API
- API version: 2020.04
- Build date: 2020-01-02T21:36:38.986Z[GMT]

# Introduction

The Dyspatch API is based on the REST paradigm and features resource based URLs
with standard HTTP response codes to indicate errors. We use standard HTTP
authentication and request verbs and all responses are JSON formatted. See our
[Implementation
Guide](https://docs.dyspatch.io/development/implementing_dyspatch/) for more
details on how to implement Dyspatch.
The Dyspatch API is based on the REST paradigm, and features resource based URLs with standard HTTP response
codes to indicate errors. We use standard HTTP authentication and request verbs, and all responses are JSON formatted.
See our [Implementation Guide](https://docs.dyspatch.io/development/implementing_dyspatch/) for more details on
how to implement Dyspatch.

For more information, please visit [https://docs.dyspatch.io](https://docs.dyspatch.io)
## API Client Libraries
Dyspatch provides API Clients for popular languages and web frameworks.

- [Java](https://github.com/getdyspatch/dyspatch-java)
- [Javascript](https://github.com/getdyspatch/dyspatch-javascript)
- [Python](https://github.com/getdyspatch/dyspatch-python)
- [C#](https://github.com/getdyspatch/dyspatch-dotnet)
- [Go](https://github.com/getdyspatch/dyspatch-golang)
- [Ruby](https://github.com/getdyspatch/dyspatch-ruby)


For more information, please visit [https://docs.dyspatch.io](https://docs.dyspatch.io)

*Automatically generated by the [OpenAPI Generator](https://openapi-generator.tech)*


## Requirements

Building the API client library requires:
1. Java 1.7+
1. Java 1.8+
2. Maven/Gradle

## Installation
Expand All @@ -48,7 +56,7 @@ Add this dependency to your project's POM:
<dependency>
<groupId>io.dyspatch</groupId>
<artifactId>dyspatch-java</artifactId>
<version>5.0.1</version>
<version>5.0.2</version>
<scope>compile</scope>
</dependency>
```
Expand All @@ -58,7 +66,7 @@ Add this dependency to your project's POM:
Add this dependency to your project's build file:

```groovy
compile "io.dyspatch:dyspatch-java:5.0.1"
compile "io.dyspatch:dyspatch-java:5.0.2"
```

### Others
Expand All @@ -71,7 +79,7 @@ mvn clean package

Then manually install the following JARs:

* `target/dyspatch-java-5.0.1.jar`
* `target/dyspatch-java-5.0.2.jar`
* `target/lib/*.jar`

## Getting Started
Expand All @@ -92,16 +100,17 @@ public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.dyspatch.io");

// Configure API key authorization: Bearer
defaultClient.setApiKey(System.getenv("DYSPATCH_API_KEY"));
defaultClient.setApiKeyPrefix("Bearer");
ApiKeyAuth Bearer = (ApiKeyAuth) defaultClient.getAuthentication("Bearer");
Bearer.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.setApiKeyPrefix("Token");

// Initialize your API objects:
DraftsApi apiInstance = new DraftsApi(defaultClient);
String draftId = "draftId_example"; // String | A draft ID
String languageId = "languageId_example"; // String | A language ID (eg: en-US)
String accept = "application/vnd.dyspatch.2020.04+json";
String accept = "accept_example"; // String | A version of the API that should be used for the request. For example, to use version \"2020.04\", set the value to \"application/vnd.dyspatch.2020.04+json\"
try {
apiInstance.deleteLocalization(draftId, languageId, accept);
} catch (ApiException e) {
Expand Down
Loading