https://github.com/newtonproject/hep-sdk-php
https://github.com/newtonproject/hep-sdk-php
Last synced: 9 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/newtonproject/hep-sdk-php
- Owner: newtonproject
- License: gpl-3.0
- Created: 2019-06-28T08:34:12.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2019-11-07T03:07:55.000Z (about 6 years ago)
- Last Synced: 2025-01-21T23:35:08.050Z (11 months ago)
- Language: PHP
- Size: 146 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# HepRestApi
The REST API for HEP protocol
This PHP package is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
- API version: v1
- Build package: io.swagger.codegen.languages.PhpClientCodegen
## Requirements
PHP 5.5 and later
## Installation & Usage
### Composer
To install the bindings via [Composer](http://getcomposer.org/), add the following to `composer.json`:
```
{
"repositories": [
{
"type": "git",
"url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git"
}
],
"require": {
"GIT_USER_ID/GIT_REPO_ID": "*@dev"
}
}
```
Then run `composer install`
### Manual Installation
Download the files and include `autoload.php`:
```php
require_once('/path/to/HepRestApi/vendor/autoload.php');
```
## Tests
To run the unit tests:
```
composer install
./vendor/bin/phpunit
```
## Getting Started
Please follow the [installation procedure](#installation--usage) and then run the following:
```php
restDappsRead($api_version, $dapp_id, $dapp_key, $protocol, $version, $ts, $nonce, $os, $language, $dapp_signature_method, $dapp_signature);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling RestApi->restDappsRead: ', $e->getMessage(), PHP_EOL;
}
?>
```
## Documentation for API Endpoints
All URIs are relative to *http://localhost*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*RestApi* | [**restDappsRead**](docs/Api/RestApi.md#restdappsread) | **GET** /rest/v{api_version}/dapps/{dapp_id}/ |
*RestApi* | [**restDappsRead_0**](docs/Api/RestApi.md#restdappsread_0) | **GET** /rest/v{api_version}/dapps/{dapp_id}/{date}/ |
*RestApi* | [**restHealthList**](docs/Api/RestApi.md#resthealthlist) | **GET** /rest/v{api_version}/health/ |
*RestApi* | [**restNewchainTxRead**](docs/Api/RestApi.md#restnewchaintxread) | **GET** /rest/v{api_version}/newchain/tx/{txid}/ |
*RestApi* | [**restNewforceRead**](docs/Api/RestApi.md#restnewforceread) | **GET** /rest/v{api_version}/newforce/{date}/ |
*RestApi* | [**restNewidsRead**](docs/Api/RestApi.md#restnewidsread) | **GET** /rest/v{api_version}/newids/{newid}/ |
*RestApi* | [**restNewnetCachesAuthCreate**](docs/Api/RestApi.md#restnewnetcachesauthcreate) | **POST** /rest/v{api_version}/newnet/caches/auth/ |
*RestApi* | [**restNewnetCachesAuthRead**](docs/Api/RestApi.md#restnewnetcachesauthread) | **GET** /rest/v{api_version}/newnet/caches/auth/{auth_hash}/ |
*RestApi* | [**restNewnetCachesPayCreate**](docs/Api/RestApi.md#restnewnetcachespaycreate) | **POST** /rest/v{api_version}/newnet/caches/pay/ |
*RestApi* | [**restNewnetCachesPayRead**](docs/Api/RestApi.md#restnewnetcachespayread) | **GET** /rest/v{api_version}/newnet/caches/pay/{pay_hash}/ |
*RestApi* | [**restOraclesRead**](docs/Api/RestApi.md#restoraclesread) | **GET** /rest/v{api_version}/oracles/{oracle_id}/ |
*RestApi* | [**restProofsCreate**](docs/Api/RestApi.md#restproofscreate) | **POST** /rest/v{api_version}/proofs/ |
*RestApi* | [**restProofsDelete**](docs/Api/RestApi.md#restproofsdelete) | **DELETE** /rest/v{api_version}/proofs/{proof_hash}/ |
*RestApi* | [**restProofsRead**](docs/Api/RestApi.md#restproofsread) | **GET** /rest/v{api_version}/proofs/{proof_hash}/ |
*RestApi* | [**restProofsReceiptsCreate**](docs/Api/RestApi.md#restproofsreceiptscreate) | **POST** /rest/v{api_version}/proofs/receipts/ |
*RestApi* | [**restProofsRewardsCreate**](docs/Api/RestApi.md#restproofsrewardscreate) | **POST** /rest/v{api_version}/proofs/rewards/ |
## Documentation For Models
- [AuthCacheRequest](docs/Model/AuthCacheRequest.md)
- [AuthCacheResponse](docs/Model/AuthCacheResponse.md)
- [CancelProofRequest](docs/Model/CancelProofRequest.md)
- [CancelProofResponse](docs/Model/CancelProofResponse.md)
- [CreateAuthCacheResponse](docs/Model/CreateAuthCacheResponse.md)
- [CreatePayCacheResponse](docs/Model/CreatePayCacheResponse.md)
- [CreateProofRequest](docs/Model/CreateProofRequest.md)
- [CreateProofResponse](docs/Model/CreateProofResponse.md)
- [Dapp](docs/Model/Dapp.md)
- [NewchainTransactionResponse](docs/Model/NewchainTransactionResponse.md)
- [NewforceDailyStatsResponse](docs/Model/NewforceDailyStatsResponse.md)
- [NewidResponse](docs/Model/NewidResponse.md)
- [Order](docs/Model/Order.md)
- [OrderItem](docs/Model/OrderItem.md)
- [PayCacheRequest](docs/Model/PayCacheRequest.md)
- [PayCacheResponse](docs/Model/PayCacheResponse.md)
- [Proof](docs/Model/Proof.md)
- [ProofData](docs/Model/ProofData.md)
- [ProofResponse](docs/Model/ProofResponse.md)
- [ProofReward](docs/Model/ProofReward.md)
- [ReceiptField](docs/Model/ReceiptField.md)
- [RetrieveDappDailyStatsResponse](docs/Model/RetrieveDappDailyStatsResponse.md)
- [RetrieveOracleResponse](docs/Model/RetrieveOracleResponse.md)
- [RetrieveProofReceiptsRequest](docs/Model/RetrieveProofReceiptsRequest.md)
- [RetrieveProofReceiptsResponse](docs/Model/RetrieveProofReceiptsResponse.md)
- [RetrieveProofRewardsRequest](docs/Model/RetrieveProofRewardsRequest.md)
- [RetrieveProofRewardsResponse](docs/Model/RetrieveProofRewardsResponse.md)
- [Thing](docs/Model/Thing.md)
## Documentation For Authorization
All endpoints do not require authorization.
## Author
xiawu@zeuux.org