From b3904aa82cebfbb696ca6babac0c01a8c4384ce6 Mon Sep 17 00:00:00 2001 From: cryptobotanist <6733639@gmail.com> Date: Sat, 15 May 2021 14:50:49 +0300 Subject: [PATCH 1/5] Delete README.md --- README.md | 112 ------------------------------------------------------ 1 file changed, 112 deletions(-) delete mode 100644 README.md diff --git a/README.md b/README.md deleted file mode 100644 index e916042..0000000 --- a/README.md +++ /dev/null @@ -1,112 +0,0 @@ -# Blockchain API library (Java, v2.0.0) - -An official Java library for interacting with the Blockchain.info API (Java 1.6 required). - -### Getting started - -If you prefer building from source: - -``` -$ git clone https://github.com/blockchain/api-v1-client-java -$ cd api-v1-client-java -$ mvn install -``` - -We also provide a snapshot Maven repository for users who prefer managing dependencies that way. - -Add the following to your pom.xml: -```xml - - ... - - ... - - api-v1-client-java-mvn-repo - https://raw.githubusercontent.com/blockchain/api-v1-client-java/mvn-repo/ - - true - always - - - - ... - - ... - - info.blockchain - api - LATEST - - - ... - -``` - -The above Maven repository also works with Gradle. - -Add this to your `build.gradle`: -``` -... -repositories { - ... - maven { - url = 'https://raw.githubusercontent.com/blockchain/api-v1-client-java/mvn-repo' - } -} -... -dependencies { - ... - compile 'info.blockchain:api:1.1.5' -} -... -``` - -Note that the above procedures require Maven or Gradle. If you do not wish to use Maven or Gradle, please compile the source manually. - -The library consists of the following packages: - -* `info.blockchain.api.blockexplorer` ([docs](docs/blockexplorer.md)) ([api/blockchain_api][api1]) -* `info.blockchain.api.createwallet` ([docs](docs/createwallet.md)) ([api/create_wallet][api2]) -* `info.blockchain.api.exchangerates` ([docs](docs/exchangerates.md)) ([api/exchange\_rates\_api][api3]) -* `info.blockchain.api.pushtx` ([docs](docs/pushtx.md)) ([pushtx][api7]) -* `info.blockchain.api.receive` ([docs](docs/receive.md)) ([api/api_receive][api4]) -* `info.blockchain.api.statistics` ([docs](docs/statistics.md)) ([api/charts_api][api5]) -* `info.blockchain.api.wallet` ([docs](docs/wallet.md)) ([api/blockchain\_wallet\_api][api6]) - -In order to use `createwallet` and `wallet` you need to run an instance of [service-my-wallet-v3](https://github.com/blockchain/service-my-wallet-v3). - -### Error handling - -All methods may throw exceptions caused by incorrectly passed parameters or other problems. If a call is rejected server-side, the `APIException` exception will be thrown. In case of a network error, the `IOException` exception will be thrown. - -### Connection timeouts - -It is possible to set arbitrary connection timeouts. - -```java -info.blockchain.api.HttpClient.TIMEOUT_MS = 2000; // time out after 2000 milliseconds -``` - -### Request limits and API keys - -In order to prevent abuse some API methods require an API key approved with some basic contact information and a description of its intended use. Please request an API key [here](https://blockchain.info/api/api_create_code). - -The same API key can be used to bypass the request limiter. - -### Code Coverage Report generation - -To generate the code coverage report, execute the following command: -```sh -mvn clean verify -``` - -This will generate a code coverage report in `target/site/jacoco/index.html`. - - -[api1]: https://blockchain.info/api/blockchain_api -[api2]: https://blockchain.info/api/create_wallet -[api3]: https://blockchain.info/api/exchange_rates_api -[api4]: https://blockchain.info/api/api_receive -[api5]: https://blockchain.info/api/charts_api -[api6]: https://blockchain.info/api/blockchain_wallet_api -[api7]: https://blockchain.info/pushtx From e6c6eb7f6692a917ec57ea1487dcc600f91f7db8 Mon Sep 17 00:00:00 2001 From: cryptobotanist <6733639@gmail.com> Date: Sat, 15 May 2021 14:50:49 +0300 Subject: [PATCH 2/5] Delete README.md --- README.md | 112 ------------------------------------------------------ 1 file changed, 112 deletions(-) delete mode 100644 README.md diff --git a/README.md b/README.md deleted file mode 100644 index e916042..0000000 --- a/README.md +++ /dev/null @@ -1,112 +0,0 @@ -# Blockchain API library (Java, v2.0.0) - -An official Java library for interacting with the Blockchain.info API (Java 1.6 required). - -### Getting started - -If you prefer building from source: - -``` -$ git clone https://github.com/blockchain/api-v1-client-java -$ cd api-v1-client-java -$ mvn install -``` - -We also provide a snapshot Maven repository for users who prefer managing dependencies that way. - -Add the following to your pom.xml: -```xml - - ... - - ... - - api-v1-client-java-mvn-repo - https://raw.githubusercontent.com/blockchain/api-v1-client-java/mvn-repo/ - - true - always - - - - ... - - ... - - info.blockchain - api - LATEST - - - ... - -``` - -The above Maven repository also works with Gradle. - -Add this to your `build.gradle`: -``` -... -repositories { - ... - maven { - url = 'https://raw.githubusercontent.com/blockchain/api-v1-client-java/mvn-repo' - } -} -... -dependencies { - ... - compile 'info.blockchain:api:1.1.5' -} -... -``` - -Note that the above procedures require Maven or Gradle. If you do not wish to use Maven or Gradle, please compile the source manually. - -The library consists of the following packages: - -* `info.blockchain.api.blockexplorer` ([docs](docs/blockexplorer.md)) ([api/blockchain_api][api1]) -* `info.blockchain.api.createwallet` ([docs](docs/createwallet.md)) ([api/create_wallet][api2]) -* `info.blockchain.api.exchangerates` ([docs](docs/exchangerates.md)) ([api/exchange\_rates\_api][api3]) -* `info.blockchain.api.pushtx` ([docs](docs/pushtx.md)) ([pushtx][api7]) -* `info.blockchain.api.receive` ([docs](docs/receive.md)) ([api/api_receive][api4]) -* `info.blockchain.api.statistics` ([docs](docs/statistics.md)) ([api/charts_api][api5]) -* `info.blockchain.api.wallet` ([docs](docs/wallet.md)) ([api/blockchain\_wallet\_api][api6]) - -In order to use `createwallet` and `wallet` you need to run an instance of [service-my-wallet-v3](https://github.com/blockchain/service-my-wallet-v3). - -### Error handling - -All methods may throw exceptions caused by incorrectly passed parameters or other problems. If a call is rejected server-side, the `APIException` exception will be thrown. In case of a network error, the `IOException` exception will be thrown. - -### Connection timeouts - -It is possible to set arbitrary connection timeouts. - -```java -info.blockchain.api.HttpClient.TIMEOUT_MS = 2000; // time out after 2000 milliseconds -``` - -### Request limits and API keys - -In order to prevent abuse some API methods require an API key approved with some basic contact information and a description of its intended use. Please request an API key [here](https://blockchain.info/api/api_create_code). - -The same API key can be used to bypass the request limiter. - -### Code Coverage Report generation - -To generate the code coverage report, execute the following command: -```sh -mvn clean verify -``` - -This will generate a code coverage report in `target/site/jacoco/index.html`. - - -[api1]: https://blockchain.info/api/blockchain_api -[api2]: https://blockchain.info/api/create_wallet -[api3]: https://blockchain.info/api/exchange_rates_api -[api4]: https://blockchain.info/api/api_receive -[api5]: https://blockchain.info/api/charts_api -[api6]: https://blockchain.info/api/blockchain_wallet_api -[api7]: https://blockchain.info/pushtx From 227c76505c7c3f2a9e372708181a764404d6f860 Mon Sep 17 00:00:00 2001 From: R0GANB0RN <83799690+R0GANB0RN@users.noreply.github.com> Date: Sat, 15 May 2021 14:54:59 +0300 Subject: [PATCH 3/5] Delete README.md (#2) From 2e8f191217fe57ad680e2624f9e731f34320af51 Mon Sep 17 00:00:00 2001 From: R0GANB0RN <83799690+R0GANB0RN@users.noreply.github.com> Date: Sat, 15 May 2021 15:02:55 +0300 Subject: [PATCH 4/5] Create README.md --- README.md | 2 ++ 1 file changed, 2 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..7d2ebea --- /dev/null +++ b/README.md @@ -0,0 +1,2 @@ +# api-v1-client-java- +Blockchain Bitcoin Developer APIs - Java From dbe7044d8463ab224763cb0aba75148da428c87c Mon Sep 17 00:00:00 2001 From: Postman Integration Date: Sat, 15 May 2021 15:51:42 +0300 Subject: [PATCH 5/5] Postman created Test API 0.0.1 Commit reference: ODVmNWY0MTgtMmMwNS00MjA2LTk0OWItZmIwM2VlYWYwYTIy --- collection/PostmanAPI.json | 107 +++++++++++++++++++++++++++++++++++++ 1 file changed, 107 insertions(+) create mode 100644 collection/PostmanAPI.json diff --git a/collection/PostmanAPI.json b/collection/PostmanAPI.json new file mode 100644 index 0000000..5e367db --- /dev/null +++ b/collection/PostmanAPI.json @@ -0,0 +1,107 @@ +{ + "openapi": "3.0.0", + "info": { + "version": "0.0.1", + "title": "Test API", + "license": { + "name": "MIT" + } + }, + "servers": [ + { + "url": "http://petstore.swagger.io/v1" + } + ], + "paths": { + "/user": { + "get": { + "summary": "Details about a user", + "operationId": "listUser", + "tags": [ + "user" + ], + "parameters": [ + { + "name": "id", + "in": "query", + "description": "ID of the user", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "Details about a user", + "headers": { + "x-next": { + "description": "A link to the next page of responses", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/User" + } + } + } + }, + "default": { + "description": "unexpected error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + } + }, + "components": { + "schemas": { + "User": { + "type": "object", + "required": [ + "id", + "name" + ], + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "name": { + "type": "string" + }, + "tag": { + "type": "string" + } + } + }, + "Error": { + "type": "object", + "required": [ + "code", + "message" + ], + "properties": { + "code": { + "type": "integer", + "format": "int32" + }, + "message": { + "type": "string" + } + } + } + } + } +} \ No newline at end of file