Skip to content

nft-rainbow/rainbow-sdk-java

Repository files navigation

rainbow-apache-httpclient

Rainbow-API

  • API version: 1.0

The responses of the open api in swagger focus on the data field rather than the code and the message fields

Automatically generated by the OpenAPI Generator

Requirements

Building the API client library requires:

  1. Java 1.8+
  2. Maven/Gradle

Installation

To install the API client library to your local Maven repository, simply execute:

mvn clean install

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

mvn clean deploy

Refer to the OSSRH Guide for more information.

Maven users

Add this dependency to your project's POM:

<dependency>
  <groupId>org.openapitools</groupId>
  <artifactId>rainbow-apache-httpclient</artifactId>
  <version>1.0</version>
  <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

compile "org.openapitools:rainbow-apache-httpclient:1.0"

Others

At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

  • target/rainbow-apache-httpclient-1.0.jar
  • target/lib/*.jar

Getting Started

Please follow the installation instruction and execute the following Java code:

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.BurnsApi;

public class BurnsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://api.nftrainbow.cn/v1");
        
        BurnsApi apiInstance = new BurnsApi(defaultClient);
        String authorization = "authorization_example"; // String | Bearer Open_JWT
        ServicesBurnDto burnDto = new ServicesBurnDto(); // ServicesBurnDto | burn_dto
        try {
            ModelsBurnTask result = apiInstance.burnNft(authorization, burnDto);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BurnsApi#burnNft");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Documentation for API Endpoints

All URIs are relative to http://api.nftrainbow.cn/v1

Class Method HTTP request Description
BurnsApi burnNft POST /burns Burn NFT
BurnsApi getBurnDetail GET /burns/{id} Burn NFT detail
BurnsApi getBurnList GET /burns Obtain the burned NFTs list
ContractApi addContractSponsorWhitelist POST /contracts/{address}/sponsor/whitelist Add contract sponsored whitelist
ContractApi deployContract POST /contracts/ Deploy contract
ContractApi getContractAdmin GET /contracts/{address}/admin Get administrator of contract, only work on conflux chain
ContractApi getContractInfo GET /contracts/detail/{id} Contract detail
ContractApi getContractSponsorInfo GET /contracts/{address}/sponsor Query sponsor
ContractApi getContractSponsoredWhitelist GET /contracts/{address}/sponsor/whitelist Get contract sponsored whitelist
ContractApi listContracts GET /contracts/ Obtain contract list
ContractApi removeContractSponsorWhitelist DELETE /contracts/{address}/sponsor/whitelist Remove contract sponsored whitelist
ContractApi setContractSponsor POST /contracts/{address}/sponsor Set sponsor
ContractApi updateContractAdmin PUT /contracts/{address}/admin Update administrator of contract
FilesApi listFiles GET /files/ Obtain file list
FilesApi uploadFile POST /files/ Upload file
FilesApi uploadFileToOss POST /files/oss Upload file to OSS
LoginApi loginApp POST /login App login
LoginApi refreshAuth GET /refresh_token Refresh JWT
MetadataApi createMetadata POST /metadata/ Create NFT metadata
MetadataApi getMetadatInfo GET /metadata/{metadata_id} Query metadata
MetadataApi listMetadatas GET /metadata/ Obtain metadata list
MintsApi batchCustomMint POST /mints/customizable/batch Batch Mint NFTs
MintsApi customMint POST /mints/ Mint NFT
MintsApi easyMintByFile POST /mints/easy/files Mint NFT with file
MintsApi easyMintByMetadata POST /mints/easy/urls Mint NFT with metadata
MintsApi getMintDetail GET /mints/{id} Mint NFT detail
MintsApi listMints GET /mints/ Obtain NFT list
NftsApi nFTInfo GET /nft/{address}/{token_id} Get NFT info, mainly owner and metadata
TransactionApi getTransactionByID GET /tx/{id} Get transaction informantion by ID
TransfersApi batchTransferNft POST /transfers/customizable/batch Batch Transfer NFTs
TransfersApi getTransferDetail GET /transfers/{id} Transfer NFT detail
TransfersApi listTransfer GET /transfers/ Obtain the transferred NFTs list
TransfersApi transferNft POST /transfers/customizable Transfer NFT

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization. Authentication schemes defined for the API:

Recommendation

It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.

Author

Releases

No releases published

Packages

No packages published

Languages