You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Feb 17, 2026. It is now read-only.
> A Java implementation of the OriginStamp API. For endpoint documentation see [OriginStamp Documentation](https://docs.originstamp.com)
7
7
8
-
## Table of Contents
8
+
> A Java implementation of the OriginStamp API. For endpoint documentation see [OriginStamp Documentation](https://docs.originstamp.com).
9
9
10
-
-[Installation](#installation)
11
-
-[Usage](#usage)
12
-
-[Building](#building)
13
-
-[Contribute](#contribute)
14
-
-[License](#license)
15
10
16
-
## Installation
11
+
## OriginStamp API Documentation
12
+
13
+
OriginStamp is a trusted timestamping service that uses the decentralized blockchain to store anonymous, tamper-proof timestamps for any digital content. OriginStamp allows users to timestamp files, emails, or plain text, and subsequently store the created hashes in the blockchain as well as retrieve and verify timetamps that have been committed to the blockchain.The trusted timestamping service of OriginStamp allows you to generate a hash fingerprint and prove that it was created at a specific point in time. If you are interested in integrating trusted timestamping into your own project, feel free to use our provided API. The following interactive documentation describes the interfaces and supports your integration. With this documentation you are able to try out the different requests and see the responses. For the authorization, add your API key to the Authorization header of your request.<br/><h2>Timestamping Steps</h2><ol><li><strong>Determine Hash: </strong> Calculate the SHA-256 of your record using a cryptographic library.</li><li><strong>Create Timestamp: </strong>Create a timestamp and add meta information to index it, e.g. a comment. You can also request a notification (email or webhook) once the tamper-proof timestamp has been created.</li><li><strong>Archive original file: </strong>Since we have no access to your original data, you should archive it because the timestamp is only valid in combination with the original file.</li><li><strong>Check Timestamp Status: </strong>Since the timestamps are always transmitted to the blockchain network at certain times, i.e. there is a delay, you can check the status of a hash and thus get the timestamp information.</li><li><strong>Get Timestamp Proof: </strong>As soon as the tamper-proof timestamp has been generated, you should archive the proof (Merkle Tree), which we created in our open procedure, together with the original file. With this proof, the existence of the file can be verified independently of OriginStamp. Here you can choose if the raw proof (xml) is sufficient proof or if you want to have a certificate (pdf).</li></ol><br/><h2>Installation Notes</h2><ul><li>Make sure you set the Authorization header correctly using your API key.</li><li>If a Cloudflare error occurs, please set a custom UserAgent header.</li><li>Please have a look at the models below to find out what each field means.</li></ul>
17
14
18
-
### Official releases
15
+
For more information, please visit [https://originstamp.com](https://originstamp.com)
19
16
20
-
You can use this project by downloading the .zip file from one of the [releases](https://github.com/OriginStampTimestamping/originstamp-client-java/releases).
21
17
22
-
### Maven, Gradle, SBT
23
18
24
-
Package managers are supported through [JitPack](https://jitpack.io/#OriginStampTimestamping/originstamp-client-java/) which supports Maven, Gradle, SBT, etc.
19
+
## Requirements
20
+
21
+
Building and using the API client library requires:
22
+
1. Java 1.7+
23
+
2. Maven/Gradle
24
+
25
+
## Installation
26
+
27
+
Releases are listed [here](https://github.com/OriginStampTimestamping/originstamp-client-java/releases).
28
+
29
+
### Maven users
25
30
26
31
For Maven, add the following sections to your pom.xml (replacing $LATEST_VERSION):
27
32
```
@@ -40,19 +45,27 @@ For Maven, add the following sections to your pom.xml (replacing $LATEST_VERSION
40
45
41
46
```
42
47
43
-
### Building
44
-
Building the API client library requires [Maven](https://maven.apache.org/) to be installed.
45
48
46
-
* Clone this repository
47
-
* Add the maven dependency
48
-
* mvn clean install
49
+
### Gradle users
50
+
51
+
Add this dependency to your project's build file:
52
+
53
+
```groovy
54
+
compile "io.swagger:swagger-java-client:1.0.0"
55
+
```
56
+
57
+
### Others
58
+
59
+
At first generate the JAR by executing:
49
60
50
-
### OriginStamp
61
+
```shell
62
+
mvn clean package
63
+
```
51
64
52
-
OriginStamp.com can be used to prove the existence of a record at a specific point in time.
53
-
The resulting timestamps can be used, for example, to secure supply chains, prove damage, simplify regulatory compliance, and prove the authorship of data, such as photos.
54
-
Originally launched in 2011 as a research project to protect researchers ideas,
55
-
OriginStamp has now become a commercial product and the leading platform for blockchain-based timestamps due to the ever-increasing demand.
String authorization ="authorization_example"; // String | A valid API key is essential for authorization to handle the request.
70
-
TimestampRequest timestampRequest =newTimestampRequest(); // TimestampRequest | DTO for the hash submission. Add all relevant information concerning your hash submission.
71
-
try {
72
-
DefaultTimestampResponse result = apiInstance.createTimestamp(authorization, timestampRequest);
73
-
System.out.println(result);
74
-
} catch (ApiException e) {
75
-
System.err.println("Exception when calling TimestampApi#createTimestamp");
76
-
e.printStackTrace();
77
-
}
81
+
TimestampApi apiInstance =newTimestampApi();
82
+
String authorization ="authorization_example"; // String | A valid API key is essential for authorization to handle the request.
83
+
TimestampRequest timestampRequest =newTimestampRequest(); // TimestampRequest | DTO for the hash submission. Add all relevant information concerning your hash submission.
84
+
try {
85
+
DefaultTimestampResponse result = apiInstance.createTimestamp(authorization, timestampRequest);
86
+
System.out.println(result);
87
+
} catch (ApiException e) {
88
+
System.err.println("Exception when calling TimestampApi#createTimestamp");
89
+
e.printStackTrace();
90
+
}
91
+
78
92
```
79
93
80
94
## Documentation for API Endpoints
@@ -83,36 +97,43 @@ All URIs are relative to *https://api.originstamp.com*
0 commit comments