AlipayOpenAgentCommonApi

March 5, 2025 · View on GitHub

All URIs are relative to https://openapi.alipay.com

MethodHTTP requestDescription
signPOST /v3/alipay/open/agent/common/sign代签约产品通用接口

sign

Object sign(appAuthPic, appDemo, appHomeScreenshot, appItemScreenshot, appPayScreenshot, businessLicenseAuthPic, businessLicensePic, data, h5ExtraPic, h5HomeScreenshot, h5ItemScreenshot, h5PayScreenshot, h5SitesLoa, miniAppScreenshot, shopScenePic, shopSignBoardPic, specialLicensePic, webHomeScreenshot, webItemScreenshot, webPayScreenshot, webSitesLoa)

代签约产品通用接口

三方应用代理签约产品,需要配合开启事务接口使用

Example

// Import classes:
import com.alipay.v3.ApiClient;
import com.alipay.v3.ApiException;
import com.alipay.v3.Configuration;
import com.alipay.v3.util.*;
import com.alipay.v3.api.models.*;
import com.alipay.v3.api.AlipayOpenAgentCommonApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://openapi.alipay.com");
    // 设置alipayConfig参数(全局设置一次)
    AlipayConfig config = new AlipayConfig();
    config.setAppId("app_id");
    config.setPrivateKey("private_key");
    config.setAlipayPublicKey("alipay_public_key");
    config.setEncryptKey("encrypt_key");
    defaultClient.setAlipayConfig(config);

    AlipayOpenAgentCommonApi apiInstance = new AlipayOpenAgentCommonApi(defaultClient);
    File appAuthPic = new File("/path/to/file"); // File | 
    File appDemo = new File("/path/to/file"); // File | 
    File appHomeScreenshot = new File("/path/to/file"); // File | 
    File appItemScreenshot = new File("/path/to/file"); // File | 
    File appPayScreenshot = new File("/path/to/file"); // File | 
    File businessLicenseAuthPic = new File("/path/to/file"); // File | 
    File businessLicensePic = new File("/path/to/file"); // File | 
    AlipayOpenAgentCommonSignModel data = new AlipayOpenAgentCommonSignModel(); // AlipayOpenAgentCommonSignModel | 
    File h5ExtraPic = new File("/path/to/file"); // File | 
    File h5HomeScreenshot = new File("/path/to/file"); // File | 
    File h5ItemScreenshot = new File("/path/to/file"); // File | 
    File h5PayScreenshot = new File("/path/to/file"); // File | 
    File h5SitesLoa = new File("/path/to/file"); // File | 
    File miniAppScreenshot = new File("/path/to/file"); // File | 
    File shopScenePic = new File("/path/to/file"); // File | 
    File shopSignBoardPic = new File("/path/to/file"); // File | 
    File specialLicensePic = new File("/path/to/file"); // File | 
    File webHomeScreenshot = new File("/path/to/file"); // File | 
    File webItemScreenshot = new File("/path/to/file"); // File | 
    File webPayScreenshot = new File("/path/to/file"); // File | 
    File webSitesLoa = new File("/path/to/file"); // File | 
    try {
      Object result = apiInstance.sign(appAuthPic, appDemo, appHomeScreenshot, appItemScreenshot, appPayScreenshot, businessLicenseAuthPic, businessLicensePic, data, h5ExtraPic, h5HomeScreenshot, h5ItemScreenshot, h5PayScreenshot, h5SitesLoa, miniAppScreenshot, shopScenePic, shopSignBoardPic, specialLicensePic, webHomeScreenshot, webItemScreenshot, webPayScreenshot, webSitesLoa);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling AlipayOpenAgentCommonApi#sign");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

NameTypeDescriptionNotes
appAuthPicFile[optional]
appDemoFile[optional]
appHomeScreenshotFile[optional]
appItemScreenshotFile[optional]
appPayScreenshotFile[optional]
businessLicenseAuthPicFile[optional]
businessLicensePicFile[optional]
dataAlipayOpenAgentCommonSignModel[optional]
h5ExtraPicFile[optional]
h5HomeScreenshotFile[optional]
h5ItemScreenshotFile[optional]
h5PayScreenshotFile[optional]
h5SitesLoaFile[optional]
miniAppScreenshotFile[optional]
shopScenePicFile[optional]
shopSignBoardPicFile[optional]
specialLicensePicFile[optional]
webHomeScreenshotFile[optional]
webItemScreenshotFile[optional]
webPayScreenshotFile[optional]
webSitesLoaFile[optional]

Return type

Object

Authorization

No authorization required

HTTP request headers

  • Content-Type: multipart/form-data
  • Accept: application/json

HTTP response details

Status codeDescriptionResponse headers
200common response-
0请求失败-