Skip to content

CodeApi.md

Latest commit

 

History

History
238 lines (168 loc) · 7.01 KB

CodeApi.md

File metadata and controls

238 lines (168 loc) · 7.01 KB

CodeApi

All URIs are relative to https://api.elepay.io

Method HTTP request Description
closeCode DELETE /codes/{codeId} Close EasyQR code
createCode POST /codes Create EasyQR code
retrieveCode GET /codes/{codeId} Retrieve EasyQR code

closeCode

closeCode(codeId)

Close EasyQR code

EasyQRコードを削除します

Example

// Import classes:
import io.elepay.client.charge.ApiClient;
import io.elepay.client.charge.ApiException;
import io.elepay.client.charge.Configuration;
import io.elepay.client.charge.auth.*;
import io.elepay.client.charge.models.*;
import io.elepay.client.charge.api.CodeApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://api.elepay.io");
        
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        CodeApi apiInstance = new CodeApi(defaultClient);
        String codeId = "codeId_example"; // String | EasyQRコード
        try {
            apiInstance.closeCode(codeId);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#closeCode");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name Type Description Notes
codeId String EasyQRコード

Return type

null (empty response body)

Authorization

basicAuth, bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

HTTP response details

Status code Description Response headers
204 Closed -

createCode

CodeDto createCode(codeReq)

Create EasyQR code

EasyQRコードを作成します。

Example

// Import classes:
import io.elepay.client.charge.ApiClient;
import io.elepay.client.charge.ApiException;
import io.elepay.client.charge.Configuration;
import io.elepay.client.charge.auth.*;
import io.elepay.client.charge.models.*;
import io.elepay.client.charge.api.CodeApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://api.elepay.io");
        
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        CodeApi apiInstance = new CodeApi(defaultClient);
        CodeReq codeReq = new CodeReq(); // CodeReq | EasyQRコードリクエスト
        try {
            CodeDto result = apiInstance.createCode(codeReq);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#createCode");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name Type Description Notes
codeReq CodeReq EasyQRコードリクエスト

Return type

CodeDto

Authorization

basicAuth, bearerAuth

HTTP request headers

  • Content-Type: application/json;charset=utf-8
  • Accept: application/json;charset=utf-8

HTTP response details

Status code Description Response headers
201 Created -

retrieveCode

CodeDto retrieveCode(codeId)

Retrieve EasyQR code

EasyQRコードオブジェクトを取得する

Example

// Import classes:
import io.elepay.client.charge.ApiClient;
import io.elepay.client.charge.ApiException;
import io.elepay.client.charge.Configuration;
import io.elepay.client.charge.auth.*;
import io.elepay.client.charge.models.*;
import io.elepay.client.charge.api.CodeApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://api.elepay.io");
        
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        CodeApi apiInstance = new CodeApi(defaultClient);
        String codeId = "codeId_example"; // String | EasyQRコード
        try {
            CodeDto result = apiInstance.retrieveCode(codeId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#retrieveCode");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name Type Description Notes
codeId String EasyQRコード

Return type

CodeDto

Authorization

basicAuth, bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json;charset=utf-8

HTTP response details

Status code Description Response headers
200 OK -