应用配置
版本:v1
认证方式:Bearer Token
目录
接口列表
获取服务商列表
基本信息
- 接口名称:获取服务商列表
- 请求方式:GET
- 请求路径:/AppSetting/{appKey}/Providers
请求参数
Path 参数
参数名 |
示例值 |
参数描述 |
是否必填 |
appKey |
- |
- |
是 |
Query 参数
参数名 |
类型 |
示例值 |
参数描述 |
是否必填 |
bizCode |
string |
- |
业务代码 |
否 |
showFlag |
boolean |
- |
是否显示 |
否 |
示例代码
| import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.net.URI;
import com.fasterxml.jackson.databind.ObjectMapper;
import java.util.Map;
public class ApiClient {
public static void main(String[] args) {
HttpClient client = HttpClient.newHttpClient();
HttpRequest.Builder requestBuilder = HttpRequest.newBuilder()
.uri(URI.create("{server}/AppSetting/{appKey}/Providers"))
.header("Authorization", "Bearer {your_access_token}");
requestBuilder.method("get", HttpRequest.BodyPublishers.noBody());
try {
HttpResponse<String> response = client.send(requestBuilder.build(), HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
} catch (Exception e) {
e.printStackTrace();
}
}
}
|
| import requests
url = "{server}/AppSetting/{appKey}/Providers"
headers = {
"Authorization": "Bearer {your_access_token}"
}
response = requests.get(
url,
headers=headers
)
print(response.json())
|
| package main
import (
"fmt"
"io/ioutil"
"net/http"
"bytes"
"encoding/json"
)
func main() {
client := &http.Client{}
var req *http.Request
var err error
req, err = http.NewRequest("get", "{server}/AppSetting/{appKey}/Providers", nil)
if err != nil {
panic(err)
}
req.Header.Add("Authorization", "Bearer {your_access_token}")
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
body, err := ioutil.ReadAll(resp.Body)
if err != nil {
panic(err)
}
fmt.Println(string(body))
}
|
| const axios = require('axios');
const config = {
method: 'get',
url: '{server}/AppSetting/{appKey}/Providers',
headers: {
'Authorization': 'Bearer {your_access_token}'
}
};
axios(config)
.then(response => {
console.log(response.data);
})
.catch(error => {
console.error(error);
});
|
| <?php
$url = "{server}/AppSetting/{appKey}/Providers";
$headers = [
"Authorization: Bearer {your_access_token}"
];
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "get");
$response = curl_exec($ch);
curl_close($ch);
echo $response;
|
| using System;
using System.Net.Http;
using System.Threading.Tasks;
using System.Text;
using System.Text.Json;
class Program
{
static async Task Main()
{
using (var client = new HttpClient())
{
client.DefaultRequestHeaders.Add("Authorization", "Bearer {your_access_token}");
HttpResponseMessage response;
response = await client.getAsync("{server}/AppSetting/{appKey}/Providers");
var content = await response.Content.ReadAsStringAsync();
Console.WriteLine(content);
}
}
}
|
| require 'net/http'
require 'json'
uri = URI("{server}/AppSetting/{appKey}/Providers")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::undefined.new(uri)
request["Authorization"] = "Bearer {your_access_token}"
response = http.request(request)
puts response.body
|
| fetch("{server}/AppSetting/{appKey}/Providers", {
method: "get",
headers: {
"Authorization": "Bearer {your_access_token}"
}
})
.then(response => response.json())
.catch(error => console.error(error));
|
| import okhttp3.OkHttpClient;
import okhttp3.Request;
import okhttp3.Response;
import okhttp3.MediaType;
import okhttp3.RequestBody;
import org.json.JSONObject;
public class ApiClient {
private final OkHttpClient client = new OkHttpClient();
public void makeRequest() {
Request.Builder requestBuilder = new Request.Builder()
.url("{server}/AppSetting/{appKey}/Providers")
.addHeader("Authorization", "Bearer {your_access_token}");
requestBuilder.method("get", null);
try (Response response = client.newCall(requestBuilder.build()).execute()) {
System.out.println(response.body().string());
} catch (Exception e) {
e.printStackTrace();
}
}
}
|
| import Foundation
let url = URL(string: "{server}/AppSetting/{appKey}/Providers")!
var request = URLRequest(url: url)
request.httpMethod = "get"
request.setValue("Bearer {your_access_token}", forHTTPHeaderField: "Authorization")
request.setValue("application/json", forHTTPHeaderField: "Content-Type")
let task = URLSession.shared.dataTask(with: request) { data, response, error in
if let data = data {
if let json = try? JSONSerialization.jsonObject(with: data) {
print(json)
}
}
}
task.resume()
|
返回结果
| {
"code": 200 // 状态码,
"data": [
{
"id": "0" // 服务商的唯一标识符。,
"bizCode": "" // 服务商的业务代码,用于标识其所属业务领域。,
"name": "" // 服务商的名称。,
"code": "" // 服务商的唯一代码,用于系统内部标识。,
"icon": "" // 服务商图标的URL或路径。,
"description": "" // 服务商的详细描述信息。,
"tags": "" // 用于分类或标记服务商的标签。,
"show": false // 指示服务商是否在界面上显示。,
"showIndex": "0" // 服务商在界面上的显示顺序。,
"createDate": "" // 服务商记录的创建日期,默认为当前时间。,
"lastUpdate": "" // 服务商记录的最后更新日期,默认为当前时间。
}
] // 响应数据,
"error": "" // 错误信息
}
|
字段名 |
类型 |
描述 |
是否必填 |
code |
integer |
状态码 |
否 |
data |
array<ServiceProvider> |
响应数据 |
否 |
error |
string |
错误信息 |
否 |
添加服务商
基本信息
- 接口名称:添加服务商
- 请求方式:POST
- 请求路径:/AppSetting/{appKey}/Providers
请求参数
Path 参数
参数名 |
示例值 |
参数描述 |
是否必填 |
appKey |
- |
- |
是 |
Body 参数
参数名 |
类型 |
示例值 |
参数描述 |
是否必填 |
id |
integer |
- |
服务商的唯一标识符。 |
否 |
bizCode |
string |
- |
服务商的业务代码,用于标识其所属业务领域。 |
否 |
name |
string |
- |
服务商的名称。 |
否 |
code |
string |
- |
服务商的唯一代码,用于系统内部标识。 |
否 |
icon |
string |
- |
服务商图标的URL或路径。 |
否 |
description |
string |
- |
服务商的详细描述信息。 |
否 |
tags |
string |
- |
用于分类或标记服务商的标签。 |
否 |
show |
boolean |
- |
指示服务商是否在界面上显示。 |
否 |
showIndex |
integer |
- |
服务商在界面上的显示顺序。 |
否 |
createDate |
string |
- |
服务商记录的创建日期,默认为当前时间。 |
否 |
lastUpdate |
string |
- |
服务商记录的最后更新日期,默认为当前时间。 |
否 |
示例代码
| import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.net.URI;
import com.fasterxml.jackson.databind.ObjectMapper;
import java.util.Map;
public class ApiClient {
public static void main(String[] args) {
HttpClient client = HttpClient.newHttpClient();
HttpRequest.Builder requestBuilder = HttpRequest.newBuilder()
.uri(URI.create("{server}/AppSetting/{appKey}/Providers"))
.header("Authorization", "Bearer {your_access_token}")
.header("Content-Type", "application/json");
// 创建请求体数据
Map<String, Object> data = {
"id": "0" // 服务商的唯一标识符。,
"bizCode": "" // 服务商的业务代码,用于标识其所属业务领域。,
"name": "" // 服务商的名称。,
"code": "" // 服务商的唯一代码,用于系统内部标识。,
"icon": "" // 服务商图标的URL或路径。,
"description": "" // 服务商的详细描述信息。,
"tags": "" // 用于分类或标记服务商的标签。,
"show": false // 指示服务商是否在界面上显示。,
"showIndex": "0" // 服务商在界面上的显示顺序。,
"createDate": "" // 服务商记录的创建日期,默认为当前时间。,
"lastUpdate": "" // 服务商记录的最后更新日期,默认为当前时间。
};
ObjectMapper mapper = new ObjectMapper();
String jsonBody = mapper.writeValueAsString(data);
RequestBody body = RequestBody.create(
MediaType.parse("application/json"), jsonBody);
requestBuilder.method("post", HttpRequest.BodyPublishers.ofString(jsonBody));
try {
HttpResponse<String> response = client.send(requestBuilder.build(), HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
} catch (Exception e) {
e.printStackTrace();
}
}
}
|
| import requests
url = "{server}/AppSetting/{appKey}/Providers"
headers = {
"Authorization": "Bearer {your_access_token}",
"Content-Type": "application/json"
}
data = {
"id": "0" // 服务商的唯一标识符。,
"bizCode": "" // 服务商的业务代码,用于标识其所属业务领域。,
"name": "" // 服务商的名称。,
"code": "" // 服务商的唯一代码,用于系统内部标识。,
"icon": "" // 服务商图标的URL或路径。,
"description": "" // 服务商的详细描述信息。,
"tags": "" // 用于分类或标记服务商的标签。,
"show": false // 指示服务商是否在界面上显示。,
"showIndex": "0" // 服务商在界面上的显示顺序。,
"createDate": "" // 服务商记录的创建日期,默认为当前时间。,
"lastUpdate": "" // 服务商记录的最后更新日期,默认为当前时间。
}
response = requests.post(
url,
headers=headers,
json=data
)
print(response.json())
|
| package main
import (
"fmt"
"io/ioutil"
"net/http"
"bytes"
"encoding/json"
)
func main() {
client := &http.Client{}
var req *http.Request
var err error
data := {
"id": "0" // 服务商的唯一标识符。,
"bizCode": "" // 服务商的业务代码,用于标识其所属业务领域。,
"name": "" // 服务商的名称。,
"code": "" // 服务商的唯一代码,用于系统内部标识。,
"icon": "" // 服务商图标的URL或路径。,
"description": "" // 服务商的详细描述信息。,
"tags": "" // 用于分类或标记服务商的标签。,
"show": false // 指示服务商是否在界面上显示。,
"showIndex": "0" // 服务商在界面上的显示顺序。,
"createDate": "" // 服务商记录的创建日期,默认为当前时间。,
"lastUpdate": "" // 服务商记录的最后更新日期,默认为当前时间。
}
jsonBody, err := json.Marshal(data)
if err != nil {
panic(err)
}
req, err = http.NewRequest("post", "{server}/AppSetting/{appKey}/Providers", bytes.NewBuffer(jsonBody))
if err != nil {
panic(err)
}
req.Header.Set("Content-Type", "application/json")
req.Header.Add("Authorization", "Bearer {your_access_token}")
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
body, err := ioutil.ReadAll(resp.Body)
if err != nil {
panic(err)
}
fmt.Println(string(body))
}
|
| const axios = require('axios');
const data = {
"id": "0" // 服务商的唯一标识符。,
"bizCode": "" // 服务商的业务代码,用于标识其所属业务领域。,
"name": "" // 服务商的名称。,
"code": "" // 服务商的唯一代码,用于系统内部标识。,
"icon": "" // 服务商图标的URL或路径。,
"description": "" // 服务商的详细描述信息。,
"tags": "" // 用于分类或标记服务商的标签。,
"show": false // 指示服务商是否在界面上显示。,
"showIndex": "0" // 服务商在界面上的显示顺序。,
"createDate": "" // 服务商记录的创建日期,默认为当前时间。,
"lastUpdate": "" // 服务商记录的最后更新日期,默认为当前时间。
};
const config = {
method: 'post',
url: '{server}/AppSetting/{appKey}/Providers',
headers: {
'Authorization': 'Bearer {your_access_token}',
'Content-Type': 'application/json'
},
data: data
};
axios(config)
.then(response => {
console.log(response.data);
})
.catch(error => {
console.error(error);
});
|
| <?php
$url = "{server}/AppSetting/{appKey}/Providers";
$headers = [
"Authorization: Bearer {your_access_token}",
"Content-Type: application/json"
];
$data = {
"id": "0" // 服务商的唯一标识符。,
"bizCode": "" // 服务商的业务代码,用于标识其所属业务领域。,
"name": "" // 服务商的名称。,
"code": "" // 服务商的唯一代码,用于系统内部标识。,
"icon": "" // 服务商图标的URL或路径。,
"description": "" // 服务商的详细描述信息。,
"tags": "" // 用于分类或标记服务商的标签。,
"show": false // 指示服务商是否在界面上显示。,
"showIndex": "0" // 服务商在界面上的显示顺序。,
"createDate": "" // 服务商记录的创建日期,默认为当前时间。,
"lastUpdate": "" // 服务商记录的最后更新日期,默认为当前时间。
};
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "post");
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
$response = curl_exec($ch);
curl_close($ch);
echo $response;
|
| using System;
using System.Net.Http;
using System.Threading.Tasks;
using System.Text;
using System.Text.Json;
class Program
{
static async Task Main()
{
using (var client = new HttpClient())
{
client.DefaultRequestHeaders.Add("Authorization", "Bearer {your_access_token}");
HttpResponseMessage response;
var data = {
"id": "0" // 服务商的唯一标识符。,
"bizCode": "" // 服务商的业务代码,用于标识其所属业务领域。,
"name": "" // 服务商的名称。,
"code": "" // 服务商的唯一代码,用于系统内部标识。,
"icon": "" // 服务商图标的URL或路径。,
"description": "" // 服务商的详细描述信息。,
"tags": "" // 用于分类或标记服务商的标签。,
"show": false // 指示服务商是否在界面上显示。,
"showIndex": "0" // 服务商在界面上的显示顺序。,
"createDate": "" // 服务商记录的创建日期,默认为当前时间。,
"lastUpdate": "" // 服务商记录的最后更新日期,默认为当前时间。
};
var content = new StringContent(
JsonSerializer.Serialize(data),
Encoding.UTF8,
"application/json");
response = await client.postAsync("{server}/AppSetting/{appKey}/Providers", content);
var content = await response.Content.ReadAsStringAsync();
Console.WriteLine(content);
}
}
}
|
| require 'net/http'
require 'json'
uri = URI("{server}/AppSetting/{appKey}/Providers")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::undefined.new(uri)
request["Authorization"] = "Bearer {your_access_token}"
request["Content-Type"] = "application/json"
data = {
"id": "0" // 服务商的唯一标识符。,
"bizCode": "" // 服务商的业务代码,用于标识其所属业务领域。,
"name": "" // 服务商的名称。,
"code": "" // 服务商的唯一代码,用于系统内部标识。,
"icon": "" // 服务商图标的URL或路径。,
"description": "" // 服务商的详细描述信息。,
"tags": "" // 用于分类或标记服务商的标签。,
"show": false // 指示服务商是否在界面上显示。,
"showIndex": "0" // 服务商在界面上的显示顺序。,
"createDate": "" // 服务商记录的创建日期,默认为当前时间。,
"lastUpdate": "" // 服务商记录的最后更新日期,默认为当前时间。
}
request.set_form_data(data)
response = http.request(request)
puts response.body
|
| const data = {
"id": "0" // 服务商的唯一标识符。,
"bizCode": "" // 服务商的业务代码,用于标识其所属业务领域。,
"name": "" // 服务商的名称。,
"code": "" // 服务商的唯一代码,用于系统内部标识。,
"icon": "" // 服务商图标的URL或路径。,
"description": "" // 服务商的详细描述信息。,
"tags": "" // 用于分类或标记服务商的标签。,
"show": false // 指示服务商是否在界面上显示。,
"showIndex": "0" // 服务商在界面上的显示顺序。,
"createDate": "" // 服务商记录的创建日期,默认为当前时间。,
"lastUpdate": "" // 服务商记录的最后更新日期,默认为当前时间。
};
fetch("{server}/AppSetting/{appKey}/Providers", {
method: "post",
headers: {
"Authorization": "Bearer {your_access_token}",
'Content-Type': 'application/json'
},
body: JSON.stringify(data)
})
.then(response => response.json())
.catch(error => console.error(error));
|
| import okhttp3.OkHttpClient;
import okhttp3.Request;
import okhttp3.Response;
import okhttp3.MediaType;
import okhttp3.RequestBody;
import org.json.JSONObject;
public class ApiClient {
private final OkHttpClient client = new OkHttpClient();
public void makeRequest() {
Request.Builder requestBuilder = new Request.Builder()
.url("{server}/AppSetting/{appKey}/Providers")
.addHeader("Authorization", "Bearer {your_access_token}")
.addHeader("Content-Type", "application/json");
JSONObject data = {
"id": "0" // 服务商的唯一标识符。,
"bizCode": "" // 服务商的业务代码,用于标识其所属业务领域。,
"name": "" // 服务商的名称。,
"code": "" // 服务商的唯一代码,用于系统内部标识。,
"icon": "" // 服务商图标的URL或路径。,
"description": "" // 服务商的详细描述信息。,
"tags": "" // 用于分类或标记服务商的标签。,
"show": false // 指示服务商是否在界面上显示。,
"showIndex": "0" // 服务商在界面上的显示顺序。,
"createDate": "" // 服务商记录的创建日期,默认为当前时间。,
"lastUpdate": "" // 服务商记录的最后更新日期,默认为当前时间。
};
RequestBody body = RequestBody.create(
MediaType.parse("application/json"), data.toString());
requestBuilder.method("post", body);
try (Response response = client.newCall(requestBuilder.build()).execute()) {
System.out.println(response.body().string());
} catch (Exception e) {
e.printStackTrace();
}
}
}
|
| import Foundation
let url = URL(string: "{server}/AppSetting/{appKey}/Providers")!
var request = URLRequest(url: url)
request.httpMethod = "post"
request.setValue("Bearer {your_access_token}", forHTTPHeaderField: "Authorization")
request.setValue("application/json", forHTTPHeaderField: "Content-Type")
let data = {
"id": "0" // 服务商的唯一标识符。,
"bizCode": "" // 服务商的业务代码,用于标识其所属业务领域。,
"name": "" // 服务商的名称。,
"code": "" // 服务商的唯一代码,用于系统内部标识。,
"icon": "" // 服务商图标的URL或路径。,
"description": "" // 服务商的详细描述信息。,
"tags": "" // 用于分类或标记服务商的标签。,
"show": false // 指示服务商是否在界面上显示。,
"showIndex": "0" // 服务商在界面上的显示顺序。,
"createDate": "" // 服务商记录的创建日期,默认为当前时间。,
"lastUpdate": "" // 服务商记录的最后更新日期,默认为当前时间。
}
let jsonData = try? JSONSerialization.data(withJSONObject: data)
request.httpBody = jsonData
let task = URLSession.shared.dataTask(with: request) { data, response, error in
if let data = data {
if let json = try? JSONSerialization.jsonObject(with: data) {
print(json)
}
}
}
task.resume()
|
返回结果
| {
"code": 200 // 状态码,
"data": {
"id": "0"
},
"error": "" // 错误信息
}
|
获取服务商详情
基本信息
- 接口名称:获取服务商详情
- 请求方式:GET
- 请求路径:/AppSetting/{appKey}/Providers/{id}
请求参数
Path 参数
参数名 |
示例值 |
参数描述 |
是否必填 |
id |
- |
服务商ID |
是 |
appKey |
- |
- |
是 |
示例代码
| import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.net.URI;
import com.fasterxml.jackson.databind.ObjectMapper;
import java.util.Map;
public class ApiClient {
public static void main(String[] args) {
HttpClient client = HttpClient.newHttpClient();
HttpRequest.Builder requestBuilder = HttpRequest.newBuilder()
.uri(URI.create("{server}/AppSetting/{appKey}/Providers/{id}"))
.header("Authorization", "Bearer {your_access_token}");
requestBuilder.method("get", HttpRequest.BodyPublishers.noBody());
try {
HttpResponse<String> response = client.send(requestBuilder.build(), HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
} catch (Exception e) {
e.printStackTrace();
}
}
}
|
| import requests
url = "{server}/AppSetting/{appKey}/Providers/{id}"
headers = {
"Authorization": "Bearer {your_access_token}"
}
response = requests.get(
url,
headers=headers
)
print(response.json())
|
| package main
import (
"fmt"
"io/ioutil"
"net/http"
"bytes"
"encoding/json"
)
func main() {
client := &http.Client{}
var req *http.Request
var err error
req, err = http.NewRequest("get", "{server}/AppSetting/{appKey}/Providers/{id}", nil)
if err != nil {
panic(err)
}
req.Header.Add("Authorization", "Bearer {your_access_token}")
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
body, err := ioutil.ReadAll(resp.Body)
if err != nil {
panic(err)
}
fmt.Println(string(body))
}
|
| const axios = require('axios');
const config = {
method: 'get',
url: '{server}/AppSetting/{appKey}/Providers/{id}',
headers: {
'Authorization': 'Bearer {your_access_token}'
}
};
axios(config)
.then(response => {
console.log(response.data);
})
.catch(error => {
console.error(error);
});
|
| <?php
$url = "{server}/AppSetting/{appKey}/Providers/{id}";
$headers = [
"Authorization: Bearer {your_access_token}"
];
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "get");
$response = curl_exec($ch);
curl_close($ch);
echo $response;
|
| using System;
using System.Net.Http;
using System.Threading.Tasks;
using System.Text;
using System.Text.Json;
class Program
{
static async Task Main()
{
using (var client = new HttpClient())
{
client.DefaultRequestHeaders.Add("Authorization", "Bearer {your_access_token}");
HttpResponseMessage response;
response = await client.getAsync("{server}/AppSetting/{appKey}/Providers/{id}");
var content = await response.Content.ReadAsStringAsync();
Console.WriteLine(content);
}
}
}
|
| require 'net/http'
require 'json'
uri = URI("{server}/AppSetting/{appKey}/Providers/{id}")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::undefined.new(uri)
request["Authorization"] = "Bearer {your_access_token}"
response = http.request(request)
puts response.body
|
| fetch("{server}/AppSetting/{appKey}/Providers/{id}", {
method: "get",
headers: {
"Authorization": "Bearer {your_access_token}"
}
})
.then(response => response.json())
.catch(error => console.error(error));
|
| import okhttp3.OkHttpClient;
import okhttp3.Request;
import okhttp3.Response;
import okhttp3.MediaType;
import okhttp3.RequestBody;
import org.json.JSONObject;
public class ApiClient {
private final OkHttpClient client = new OkHttpClient();
public void makeRequest() {
Request.Builder requestBuilder = new Request.Builder()
.url("{server}/AppSetting/{appKey}/Providers/{id}")
.addHeader("Authorization", "Bearer {your_access_token}");
requestBuilder.method("get", null);
try (Response response = client.newCall(requestBuilder.build()).execute()) {
System.out.println(response.body().string());
} catch (Exception e) {
e.printStackTrace();
}
}
}
|
| import Foundation
let url = URL(string: "{server}/AppSetting/{appKey}/Providers/{id}")!
var request = URLRequest(url: url)
request.httpMethod = "get"
request.setValue("Bearer {your_access_token}", forHTTPHeaderField: "Authorization")
request.setValue("application/json", forHTTPHeaderField: "Content-Type")
let task = URLSession.shared.dataTask(with: request) { data, response, error in
if let data = data {
if let json = try? JSONSerialization.jsonObject(with: data) {
print(json)
}
}
}
task.resume()
|
返回结果
| {
"code": 200 // 状态码,
"data": {
"id": "0" // 服务商的唯一标识符。,
"bizCode": "" // 服务商的业务代码,用于标识其所属业务领域。,
"name": "" // 服务商的名称。,
"code": "" // 服务商的唯一代码,用于系统内部标识。,
"icon": "" // 服务商图标的URL或路径。,
"description": "" // 服务商的详细描述信息。,
"tags": "" // 用于分类或标记服务商的标签。,
"show": false // 指示服务商是否在界面上显示。,
"showIndex": "0" // 服务商在界面上的显示顺序。,
"createDate": "" // 服务商记录的创建日期,默认为当前时间。,
"lastUpdate": "" // 服务商记录的最后更新日期,默认为当前时间。
},
"error": "" // 错误信息
}
|
字段名 |
类型 |
描述 |
是否必填 |
code |
integer |
状态码 |
否 |
data |
ServiceProvider |
- |
否 |
error |
string |
错误信息 |
否 |
更新服务商
基本信息
- 接口名称:更新服务商
- 请求方式:PUT
- 请求路径:/AppSetting/{appKey}/Providers/{id}
请求参数
Path 参数
参数名 |
示例值 |
参数描述 |
是否必填 |
id |
- |
服务商ID |
是 |
appKey |
- |
- |
是 |
Body 参数
参数名 |
类型 |
示例值 |
参数描述 |
是否必填 |
id |
integer |
- |
服务商的唯一标识符。 |
否 |
bizCode |
string |
- |
服务商的业务代码,用于标识其所属业务领域。 |
否 |
name |
string |
- |
服务商的名称。 |
否 |
code |
string |
- |
服务商的唯一代码,用于系统内部标识。 |
否 |
icon |
string |
- |
服务商图标的URL或路径。 |
否 |
description |
string |
- |
服务商的详细描述信息。 |
否 |
tags |
string |
- |
用于分类或标记服务商的标签。 |
否 |
show |
boolean |
- |
指示服务商是否在界面上显示。 |
否 |
showIndex |
integer |
- |
服务商在界面上的显示顺序。 |
否 |
createDate |
string |
- |
服务商记录的创建日期,默认为当前时间。 |
否 |
lastUpdate |
string |
- |
服务商记录的最后更新日期,默认为当前时间。 |
否 |
示例代码
| import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.net.URI;
import com.fasterxml.jackson.databind.ObjectMapper;
import java.util.Map;
public class ApiClient {
public static void main(String[] args) {
HttpClient client = HttpClient.newHttpClient();
HttpRequest.Builder requestBuilder = HttpRequest.newBuilder()
.uri(URI.create("{server}/AppSetting/{appKey}/Providers/{id}"))
.header("Authorization", "Bearer {your_access_token}")
.header("Content-Type", "application/json");
// 创建请求体数据
Map<String, Object> data = {
"id": "0" // 服务商的唯一标识符。,
"bizCode": "" // 服务商的业务代码,用于标识其所属业务领域。,
"name": "" // 服务商的名称。,
"code": "" // 服务商的唯一代码,用于系统内部标识。,
"icon": "" // 服务商图标的URL或路径。,
"description": "" // 服务商的详细描述信息。,
"tags": "" // 用于分类或标记服务商的标签。,
"show": false // 指示服务商是否在界面上显示。,
"showIndex": "0" // 服务商在界面上的显示顺序。,
"createDate": "" // 服务商记录的创建日期,默认为当前时间。,
"lastUpdate": "" // 服务商记录的最后更新日期,默认为当前时间。
};
ObjectMapper mapper = new ObjectMapper();
String jsonBody = mapper.writeValueAsString(data);
RequestBody body = RequestBody.create(
MediaType.parse("application/json"), jsonBody);
requestBuilder.method("put", HttpRequest.BodyPublishers.ofString(jsonBody));
try {
HttpResponse<String> response = client.send(requestBuilder.build(), HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
} catch (Exception e) {
e.printStackTrace();
}
}
}
|
| import requests
url = "{server}/AppSetting/{appKey}/Providers/{id}"
headers = {
"Authorization": "Bearer {your_access_token}",
"Content-Type": "application/json"
}
data = {
"id": "0" // 服务商的唯一标识符。,
"bizCode": "" // 服务商的业务代码,用于标识其所属业务领域。,
"name": "" // 服务商的名称。,
"code": "" // 服务商的唯一代码,用于系统内部标识。,
"icon": "" // 服务商图标的URL或路径。,
"description": "" // 服务商的详细描述信息。,
"tags": "" // 用于分类或标记服务商的标签。,
"show": false // 指示服务商是否在界面上显示。,
"showIndex": "0" // 服务商在界面上的显示顺序。,
"createDate": "" // 服务商记录的创建日期,默认为当前时间。,
"lastUpdate": "" // 服务商记录的最后更新日期,默认为当前时间。
}
response = requests.put(
url,
headers=headers,
json=data
)
print(response.json())
|
| package main
import (
"fmt"
"io/ioutil"
"net/http"
"bytes"
"encoding/json"
)
func main() {
client := &http.Client{}
var req *http.Request
var err error
data := {
"id": "0" // 服务商的唯一标识符。,
"bizCode": "" // 服务商的业务代码,用于标识其所属业务领域。,
"name": "" // 服务商的名称。,
"code": "" // 服务商的唯一代码,用于系统内部标识。,
"icon": "" // 服务商图标的URL或路径。,
"description": "" // 服务商的详细描述信息。,
"tags": "" // 用于分类或标记服务商的标签。,
"show": false // 指示服务商是否在界面上显示。,
"showIndex": "0" // 服务商在界面上的显示顺序。,
"createDate": "" // 服务商记录的创建日期,默认为当前时间。,
"lastUpdate": "" // 服务商记录的最后更新日期,默认为当前时间。
}
jsonBody, err := json.Marshal(data)
if err != nil {
panic(err)
}
req, err = http.NewRequest("put", "{server}/AppSetting/{appKey}/Providers/{id}", bytes.NewBuffer(jsonBody))
if err != nil {
panic(err)
}
req.Header.Set("Content-Type", "application/json")
req.Header.Add("Authorization", "Bearer {your_access_token}")
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
body, err := ioutil.ReadAll(resp.Body)
if err != nil {
panic(err)
}
fmt.Println(string(body))
}
|
| const axios = require('axios');
const data = {
"id": "0" // 服务商的唯一标识符。,
"bizCode": "" // 服务商的业务代码,用于标识其所属业务领域。,
"name": "" // 服务商的名称。,
"code": "" // 服务商的唯一代码,用于系统内部标识。,
"icon": "" // 服务商图标的URL或路径。,
"description": "" // 服务商的详细描述信息。,
"tags": "" // 用于分类或标记服务商的标签。,
"show": false // 指示服务商是否在界面上显示。,
"showIndex": "0" // 服务商在界面上的显示顺序。,
"createDate": "" // 服务商记录的创建日期,默认为当前时间。,
"lastUpdate": "" // 服务商记录的最后更新日期,默认为当前时间。
};
const config = {
method: 'put',
url: '{server}/AppSetting/{appKey}/Providers/{id}',
headers: {
'Authorization': 'Bearer {your_access_token}',
'Content-Type': 'application/json'
},
data: data
};
axios(config)
.then(response => {
console.log(response.data);
})
.catch(error => {
console.error(error);
});
|
| <?php
$url = "{server}/AppSetting/{appKey}/Providers/{id}";
$headers = [
"Authorization: Bearer {your_access_token}",
"Content-Type: application/json"
];
$data = {
"id": "0" // 服务商的唯一标识符。,
"bizCode": "" // 服务商的业务代码,用于标识其所属业务领域。,
"name": "" // 服务商的名称。,
"code": "" // 服务商的唯一代码,用于系统内部标识。,
"icon": "" // 服务商图标的URL或路径。,
"description": "" // 服务商的详细描述信息。,
"tags": "" // 用于分类或标记服务商的标签。,
"show": false // 指示服务商是否在界面上显示。,
"showIndex": "0" // 服务商在界面上的显示顺序。,
"createDate": "" // 服务商记录的创建日期,默认为当前时间。,
"lastUpdate": "" // 服务商记录的最后更新日期,默认为当前时间。
};
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "put");
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
$response = curl_exec($ch);
curl_close($ch);
echo $response;
|
| using System;
using System.Net.Http;
using System.Threading.Tasks;
using System.Text;
using System.Text.Json;
class Program
{
static async Task Main()
{
using (var client = new HttpClient())
{
client.DefaultRequestHeaders.Add("Authorization", "Bearer {your_access_token}");
HttpResponseMessage response;
var data = {
"id": "0" // 服务商的唯一标识符。,
"bizCode": "" // 服务商的业务代码,用于标识其所属业务领域。,
"name": "" // 服务商的名称。,
"code": "" // 服务商的唯一代码,用于系统内部标识。,
"icon": "" // 服务商图标的URL或路径。,
"description": "" // 服务商的详细描述信息。,
"tags": "" // 用于分类或标记服务商的标签。,
"show": false // 指示服务商是否在界面上显示。,
"showIndex": "0" // 服务商在界面上的显示顺序。,
"createDate": "" // 服务商记录的创建日期,默认为当前时间。,
"lastUpdate": "" // 服务商记录的最后更新日期,默认为当前时间。
};
var content = new StringContent(
JsonSerializer.Serialize(data),
Encoding.UTF8,
"application/json");
response = await client.putAsync("{server}/AppSetting/{appKey}/Providers/{id}", content);
var content = await response.Content.ReadAsStringAsync();
Console.WriteLine(content);
}
}
}
|
| require 'net/http'
require 'json'
uri = URI("{server}/AppSetting/{appKey}/Providers/{id}")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::undefined.new(uri)
request["Authorization"] = "Bearer {your_access_token}"
request["Content-Type"] = "application/json"
data = {
"id": "0" // 服务商的唯一标识符。,
"bizCode": "" // 服务商的业务代码,用于标识其所属业务领域。,
"name": "" // 服务商的名称。,
"code": "" // 服务商的唯一代码,用于系统内部标识。,
"icon": "" // 服务商图标的URL或路径。,
"description": "" // 服务商的详细描述信息。,
"tags": "" // 用于分类或标记服务商的标签。,
"show": false // 指示服务商是否在界面上显示。,
"showIndex": "0" // 服务商在界面上的显示顺序。,
"createDate": "" // 服务商记录的创建日期,默认为当前时间。,
"lastUpdate": "" // 服务商记录的最后更新日期,默认为当前时间。
}
request.set_form_data(data)
response = http.request(request)
puts response.body
|
| const data = {
"id": "0" // 服务商的唯一标识符。,
"bizCode": "" // 服务商的业务代码,用于标识其所属业务领域。,
"name": "" // 服务商的名称。,
"code": "" // 服务商的唯一代码,用于系统内部标识。,
"icon": "" // 服务商图标的URL或路径。,
"description": "" // 服务商的详细描述信息。,
"tags": "" // 用于分类或标记服务商的标签。,
"show": false // 指示服务商是否在界面上显示。,
"showIndex": "0" // 服务商在界面上的显示顺序。,
"createDate": "" // 服务商记录的创建日期,默认为当前时间。,
"lastUpdate": "" // 服务商记录的最后更新日期,默认为当前时间。
};
fetch("{server}/AppSetting/{appKey}/Providers/{id}", {
method: "put",
headers: {
"Authorization": "Bearer {your_access_token}",
'Content-Type': 'application/json'
},
body: JSON.stringify(data)
})
.then(response => response.json())
.catch(error => console.error(error));
|
| import okhttp3.OkHttpClient;
import okhttp3.Request;
import okhttp3.Response;
import okhttp3.MediaType;
import okhttp3.RequestBody;
import org.json.JSONObject;
public class ApiClient {
private final OkHttpClient client = new OkHttpClient();
public void makeRequest() {
Request.Builder requestBuilder = new Request.Builder()
.url("{server}/AppSetting/{appKey}/Providers/{id}")
.addHeader("Authorization", "Bearer {your_access_token}")
.addHeader("Content-Type", "application/json");
JSONObject data = {
"id": "0" // 服务商的唯一标识符。,
"bizCode": "" // 服务商的业务代码,用于标识其所属业务领域。,
"name": "" // 服务商的名称。,
"code": "" // 服务商的唯一代码,用于系统内部标识。,
"icon": "" // 服务商图标的URL或路径。,
"description": "" // 服务商的详细描述信息。,
"tags": "" // 用于分类或标记服务商的标签。,
"show": false // 指示服务商是否在界面上显示。,
"showIndex": "0" // 服务商在界面上的显示顺序。,
"createDate": "" // 服务商记录的创建日期,默认为当前时间。,
"lastUpdate": "" // 服务商记录的最后更新日期,默认为当前时间。
};
RequestBody body = RequestBody.create(
MediaType.parse("application/json"), data.toString());
requestBuilder.method("put", body);
try (Response response = client.newCall(requestBuilder.build()).execute()) {
System.out.println(response.body().string());
} catch (Exception e) {
e.printStackTrace();
}
}
}
|
| import Foundation
let url = URL(string: "{server}/AppSetting/{appKey}/Providers/{id}")!
var request = URLRequest(url: url)
request.httpMethod = "put"
request.setValue("Bearer {your_access_token}", forHTTPHeaderField: "Authorization")
request.setValue("application/json", forHTTPHeaderField: "Content-Type")
let data = {
"id": "0" // 服务商的唯一标识符。,
"bizCode": "" // 服务商的业务代码,用于标识其所属业务领域。,
"name": "" // 服务商的名称。,
"code": "" // 服务商的唯一代码,用于系统内部标识。,
"icon": "" // 服务商图标的URL或路径。,
"description": "" // 服务商的详细描述信息。,
"tags": "" // 用于分类或标记服务商的标签。,
"show": false // 指示服务商是否在界面上显示。,
"showIndex": "0" // 服务商在界面上的显示顺序。,
"createDate": "" // 服务商记录的创建日期,默认为当前时间。,
"lastUpdate": "" // 服务商记录的最后更新日期,默认为当前时间。
}
let jsonData = try? JSONSerialization.data(withJSONObject: data)
request.httpBody = jsonData
let task = URLSession.shared.dataTask(with: request) { data, response, error in
if let data = data {
if let json = try? JSONSerialization.jsonObject(with: data) {
print(json)
}
}
}
task.resume()
|
返回结果
| {
"code": 200 // 状态码,
"data": false // 响应数据,
"error": "" // 错误信息
}
|
字段名 |
类型 |
描述 |
是否必填 |
code |
integer |
状态码 |
否 |
data |
boolean |
响应数据 |
否 |
error |
string |
错误信息 |
否 |
删除服务商
基本信息
- 接口名称:删除服务商
- 请求方式:DELETE
- 请求路径:/AppSetting/{appKey}/Providers/{id}
请求参数
Path 参数
参数名 |
示例值 |
参数描述 |
是否必填 |
id |
- |
服务商ID |
是 |
appKey |
- |
- |
是 |
示例代码
| import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.net.URI;
import com.fasterxml.jackson.databind.ObjectMapper;
import java.util.Map;
public class ApiClient {
public static void main(String[] args) {
HttpClient client = HttpClient.newHttpClient();
HttpRequest.Builder requestBuilder = HttpRequest.newBuilder()
.uri(URI.create("{server}/AppSetting/{appKey}/Providers/{id}"))
.header("Authorization", "Bearer {your_access_token}");
requestBuilder.method("delete", HttpRequest.BodyPublishers.noBody());
try {
HttpResponse<String> response = client.send(requestBuilder.build(), HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
} catch (Exception e) {
e.printStackTrace();
}
}
}
|
| import requests
url = "{server}/AppSetting/{appKey}/Providers/{id}"
headers = {
"Authorization": "Bearer {your_access_token}"
}
response = requests.delete(
url,
headers=headers
)
print(response.json())
|
| package main
import (
"fmt"
"io/ioutil"
"net/http"
"bytes"
"encoding/json"
)
func main() {
client := &http.Client{}
var req *http.Request
var err error
req, err = http.NewRequest("delete", "{server}/AppSetting/{appKey}/Providers/{id}", nil)
if err != nil {
panic(err)
}
req.Header.Add("Authorization", "Bearer {your_access_token}")
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
body, err := ioutil.ReadAll(resp.Body)
if err != nil {
panic(err)
}
fmt.Println(string(body))
}
|
| const axios = require('axios');
const config = {
method: 'delete',
url: '{server}/AppSetting/{appKey}/Providers/{id}',
headers: {
'Authorization': 'Bearer {your_access_token}'
}
};
axios(config)
.then(response => {
console.log(response.data);
})
.catch(error => {
console.error(error);
});
|
| <?php
$url = "{server}/AppSetting/{appKey}/Providers/{id}";
$headers = [
"Authorization: Bearer {your_access_token}"
];
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "delete");
$response = curl_exec($ch);
curl_close($ch);
echo $response;
|
| using System;
using System.Net.Http;
using System.Threading.Tasks;
using System.Text;
using System.Text.Json;
class Program
{
static async Task Main()
{
using (var client = new HttpClient())
{
client.DefaultRequestHeaders.Add("Authorization", "Bearer {your_access_token}");
HttpResponseMessage response;
response = await client.deleteAsync("{server}/AppSetting/{appKey}/Providers/{id}");
var content = await response.Content.ReadAsStringAsync();
Console.WriteLine(content);
}
}
}
|
| require 'net/http'
require 'json'
uri = URI("{server}/AppSetting/{appKey}/Providers/{id}")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::undefined.new(uri)
request["Authorization"] = "Bearer {your_access_token}"
response = http.request(request)
puts response.body
|
| fetch("{server}/AppSetting/{appKey}/Providers/{id}", {
method: "delete",
headers: {
"Authorization": "Bearer {your_access_token}"
}
})
.then(response => response.json())
.catch(error => console.error(error));
|
| import okhttp3.OkHttpClient;
import okhttp3.Request;
import okhttp3.Response;
import okhttp3.MediaType;
import okhttp3.RequestBody;
import org.json.JSONObject;
public class ApiClient {
private final OkHttpClient client = new OkHttpClient();
public void makeRequest() {
Request.Builder requestBuilder = new Request.Builder()
.url("{server}/AppSetting/{appKey}/Providers/{id}")
.addHeader("Authorization", "Bearer {your_access_token}");
requestBuilder.method("delete", null);
try (Response response = client.newCall(requestBuilder.build()).execute()) {
System.out.println(response.body().string());
} catch (Exception e) {
e.printStackTrace();
}
}
}
|
| import Foundation
let url = URL(string: "{server}/AppSetting/{appKey}/Providers/{id}")!
var request = URLRequest(url: url)
request.httpMethod = "delete"
request.setValue("Bearer {your_access_token}", forHTTPHeaderField: "Authorization")
request.setValue("application/json", forHTTPHeaderField: "Content-Type")
let task = URLSession.shared.dataTask(with: request) { data, response, error in
if let data = data {
if let json = try? JSONSerialization.jsonObject(with: data) {
print(json)
}
}
}
task.resume()
|
返回结果
| {
"code": 200 // 状态码,
"data": false // 响应数据,
"error": "" // 错误信息
}
|
字段名 |
类型 |
描述 |
是否必填 |
code |
integer |
状态码 |
否 |
data |
boolean |
响应数据 |
否 |
error |
string |
错误信息 |
否 |
获取服务分组列表
接口说明
根据服务商ID和显示标志获取服务分组列表
基本信息
- 接口名称:获取服务分组列表
- 请求方式:GET
- 请求路径:/AppSetting/{appKey}/Groups
请求参数
Path 参数
参数名 |
示例值 |
参数描述 |
是否必填 |
appKey |
- |
- |
是 |
Query 参数
参数名 |
类型 |
示例值 |
参数描述 |
是否必填 |
providerId |
integer |
- |
服务商ID |
否 |
showFlag |
boolean |
- |
是否显示 |
否 |
示例代码
| import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.net.URI;
import com.fasterxml.jackson.databind.ObjectMapper;
import java.util.Map;
public class ApiClient {
public static void main(String[] args) {
HttpClient client = HttpClient.newHttpClient();
HttpRequest.Builder requestBuilder = HttpRequest.newBuilder()
.uri(URI.create("{server}/AppSetting/{appKey}/Groups"))
.header("Authorization", "Bearer {your_access_token}");
requestBuilder.method("get", HttpRequest.BodyPublishers.noBody());
try {
HttpResponse<String> response = client.send(requestBuilder.build(), HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
} catch (Exception e) {
e.printStackTrace();
}
}
}
|
| import requests
url = "{server}/AppSetting/{appKey}/Groups"
headers = {
"Authorization": "Bearer {your_access_token}"
}
response = requests.get(
url,
headers=headers
)
print(response.json())
|
| package main
import (
"fmt"
"io/ioutil"
"net/http"
"bytes"
"encoding/json"
)
func main() {
client := &http.Client{}
var req *http.Request
var err error
req, err = http.NewRequest("get", "{server}/AppSetting/{appKey}/Groups", nil)
if err != nil {
panic(err)
}
req.Header.Add("Authorization", "Bearer {your_access_token}")
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
body, err := ioutil.ReadAll(resp.Body)
if err != nil {
panic(err)
}
fmt.Println(string(body))
}
|
| const axios = require('axios');
const config = {
method: 'get',
url: '{server}/AppSetting/{appKey}/Groups',
headers: {
'Authorization': 'Bearer {your_access_token}'
}
};
axios(config)
.then(response => {
console.log(response.data);
})
.catch(error => {
console.error(error);
});
|
| <?php
$url = "{server}/AppSetting/{appKey}/Groups";
$headers = [
"Authorization: Bearer {your_access_token}"
];
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "get");
$response = curl_exec($ch);
curl_close($ch);
echo $response;
|
| using System;
using System.Net.Http;
using System.Threading.Tasks;
using System.Text;
using System.Text.Json;
class Program
{
static async Task Main()
{
using (var client = new HttpClient())
{
client.DefaultRequestHeaders.Add("Authorization", "Bearer {your_access_token}");
HttpResponseMessage response;
response = await client.getAsync("{server}/AppSetting/{appKey}/Groups");
var content = await response.Content.ReadAsStringAsync();
Console.WriteLine(content);
}
}
}
|
| require 'net/http'
require 'json'
uri = URI("{server}/AppSetting/{appKey}/Groups")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::undefined.new(uri)
request["Authorization"] = "Bearer {your_access_token}"
response = http.request(request)
puts response.body
|
| fetch("{server}/AppSetting/{appKey}/Groups", {
method: "get",
headers: {
"Authorization": "Bearer {your_access_token}"
}
})
.then(response => response.json())
.catch(error => console.error(error));
|
| import okhttp3.OkHttpClient;
import okhttp3.Request;
import okhttp3.Response;
import okhttp3.MediaType;
import okhttp3.RequestBody;
import org.json.JSONObject;
public class ApiClient {
private final OkHttpClient client = new OkHttpClient();
public void makeRequest() {
Request.Builder requestBuilder = new Request.Builder()
.url("{server}/AppSetting/{appKey}/Groups")
.addHeader("Authorization", "Bearer {your_access_token}");
requestBuilder.method("get", null);
try (Response response = client.newCall(requestBuilder.build()).execute()) {
System.out.println(response.body().string());
} catch (Exception e) {
e.printStackTrace();
}
}
}
|
| import Foundation
let url = URL(string: "{server}/AppSetting/{appKey}/Groups")!
var request = URLRequest(url: url)
request.httpMethod = "get"
request.setValue("Bearer {your_access_token}", forHTTPHeaderField: "Authorization")
request.setValue("application/json", forHTTPHeaderField: "Content-Type")
let task = URLSession.shared.dataTask(with: request) { data, response, error in
if let data = data {
if let json = try? JSONSerialization.jsonObject(with: data) {
print(json)
}
}
}
task.resume()
|
返回结果
| {
"code": 200 // 状态码,
"data": [
{
"id": "0" // 服务功能分组的唯一标识符。,
"providerID": "0" // 关联的服务商的唯一标识符。,
"name": "" // 服务功能分组的名称。,
"code": "" // 服务功能分组的唯一代码,用于系统内部标识。,
"icon": "" // 服务功能分组的图标URL或路径。,
"description": "" // 服务功能分组的详细描述信息。,
"show": false // 指示服务功能分组是否在界面上显示。,
"showIndex": "0" // 服务功能分组在界面上的显示顺序。,
"createDate": "" // 服务功能分组的创建日期,默认为当前时间。,
"lastUpdate": "" // 服务功能分组的最后更新日期,默认为当前时间。
}
] // 响应数据,
"error": "" // 错误信息
}
|
字段名 |
类型 |
描述 |
是否必填 |
code |
integer |
状态码 |
否 |
data |
array<ServiceGroup> |
响应数据 |
否 |
error |
string |
错误信息 |
否 |
添加服务分组
基本信息
- 接口名称:添加服务分组
- 请求方式:POST
- 请求路径:/AppSetting/{appKey}/Groups
请求参数
Path 参数
参数名 |
示例值 |
参数描述 |
是否必填 |
appKey |
- |
- |
是 |
Body 参数
参数名 |
类型 |
示例值 |
参数描述 |
是否必填 |
id |
integer |
- |
服务功能分组的唯一标识符。 |
否 |
providerID |
integer |
- |
关联的服务商的唯一标识符。 |
否 |
name |
string |
- |
服务功能分组的名称。 |
否 |
code |
string |
- |
服务功能分组的唯一代码,用于系统内部标识。 |
否 |
icon |
string |
- |
服务功能分组的图标URL或路径。 |
否 |
description |
string |
- |
服务功能分组的详细描述信息。 |
否 |
show |
boolean |
- |
指示服务功能分组是否在界面上显示。 |
否 |
showIndex |
integer |
- |
服务功能分组在界面上的显示顺序。 |
否 |
createDate |
string |
- |
服务功能分组的创建日期,默认为当前时间。 |
否 |
lastUpdate |
string |
- |
服务功能分组的最后更新日期,默认为当前时间。 |
否 |
示例代码
| import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.net.URI;
import com.fasterxml.jackson.databind.ObjectMapper;
import java.util.Map;
public class ApiClient {
public static void main(String[] args) {
HttpClient client = HttpClient.newHttpClient();
HttpRequest.Builder requestBuilder = HttpRequest.newBuilder()
.uri(URI.create("{server}/AppSetting/{appKey}/Groups"))
.header("Authorization", "Bearer {your_access_token}")
.header("Content-Type", "application/json");
// 创建请求体数据
Map<String, Object> data = {
"id": "0" // 服务功能分组的唯一标识符。,
"providerID": "0" // 关联的服务商的唯一标识符。,
"name": "" // 服务功能分组的名称。,
"code": "" // 服务功能分组的唯一代码,用于系统内部标识。,
"icon": "" // 服务功能分组的图标URL或路径。,
"description": "" // 服务功能分组的详细描述信息。,
"show": false // 指示服务功能分组是否在界面上显示。,
"showIndex": "0" // 服务功能分组在界面上的显示顺序。,
"createDate": "" // 服务功能分组的创建日期,默认为当前时间。,
"lastUpdate": "" // 服务功能分组的最后更新日期,默认为当前时间。
};
ObjectMapper mapper = new ObjectMapper();
String jsonBody = mapper.writeValueAsString(data);
RequestBody body = RequestBody.create(
MediaType.parse("application/json"), jsonBody);
requestBuilder.method("post", HttpRequest.BodyPublishers.ofString(jsonBody));
try {
HttpResponse<String> response = client.send(requestBuilder.build(), HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
} catch (Exception e) {
e.printStackTrace();
}
}
}
|
| import requests
url = "{server}/AppSetting/{appKey}/Groups"
headers = {
"Authorization": "Bearer {your_access_token}",
"Content-Type": "application/json"
}
data = {
"id": "0" // 服务功能分组的唯一标识符。,
"providerID": "0" // 关联的服务商的唯一标识符。,
"name": "" // 服务功能分组的名称。,
"code": "" // 服务功能分组的唯一代码,用于系统内部标识。,
"icon": "" // 服务功能分组的图标URL或路径。,
"description": "" // 服务功能分组的详细描述信息。,
"show": false // 指示服务功能分组是否在界面上显示。,
"showIndex": "0" // 服务功能分组在界面上的显示顺序。,
"createDate": "" // 服务功能分组的创建日期,默认为当前时间。,
"lastUpdate": "" // 服务功能分组的最后更新日期,默认为当前时间。
}
response = requests.post(
url,
headers=headers,
json=data
)
print(response.json())
|
| package main
import (
"fmt"
"io/ioutil"
"net/http"
"bytes"
"encoding/json"
)
func main() {
client := &http.Client{}
var req *http.Request
var err error
data := {
"id": "0" // 服务功能分组的唯一标识符。,
"providerID": "0" // 关联的服务商的唯一标识符。,
"name": "" // 服务功能分组的名称。,
"code": "" // 服务功能分组的唯一代码,用于系统内部标识。,
"icon": "" // 服务功能分组的图标URL或路径。,
"description": "" // 服务功能分组的详细描述信息。,
"show": false // 指示服务功能分组是否在界面上显示。,
"showIndex": "0" // 服务功能分组在界面上的显示顺序。,
"createDate": "" // 服务功能分组的创建日期,默认为当前时间。,
"lastUpdate": "" // 服务功能分组的最后更新日期,默认为当前时间。
}
jsonBody, err := json.Marshal(data)
if err != nil {
panic(err)
}
req, err = http.NewRequest("post", "{server}/AppSetting/{appKey}/Groups", bytes.NewBuffer(jsonBody))
if err != nil {
panic(err)
}
req.Header.Set("Content-Type", "application/json")
req.Header.Add("Authorization", "Bearer {your_access_token}")
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
body, err := ioutil.ReadAll(resp.Body)
if err != nil {
panic(err)
}
fmt.Println(string(body))
}
|
| const axios = require('axios');
const data = {
"id": "0" // 服务功能分组的唯一标识符。,
"providerID": "0" // 关联的服务商的唯一标识符。,
"name": "" // 服务功能分组的名称。,
"code": "" // 服务功能分组的唯一代码,用于系统内部标识。,
"icon": "" // 服务功能分组的图标URL或路径。,
"description": "" // 服务功能分组的详细描述信息。,
"show": false // 指示服务功能分组是否在界面上显示。,
"showIndex": "0" // 服务功能分组在界面上的显示顺序。,
"createDate": "" // 服务功能分组的创建日期,默认为当前时间。,
"lastUpdate": "" // 服务功能分组的最后更新日期,默认为当前时间。
};
const config = {
method: 'post',
url: '{server}/AppSetting/{appKey}/Groups',
headers: {
'Authorization': 'Bearer {your_access_token}',
'Content-Type': 'application/json'
},
data: data
};
axios(config)
.then(response => {
console.log(response.data);
})
.catch(error => {
console.error(error);
});
|
| <?php
$url = "{server}/AppSetting/{appKey}/Groups";
$headers = [
"Authorization: Bearer {your_access_token}",
"Content-Type: application/json"
];
$data = {
"id": "0" // 服务功能分组的唯一标识符。,
"providerID": "0" // 关联的服务商的唯一标识符。,
"name": "" // 服务功能分组的名称。,
"code": "" // 服务功能分组的唯一代码,用于系统内部标识。,
"icon": "" // 服务功能分组的图标URL或路径。,
"description": "" // 服务功能分组的详细描述信息。,
"show": false // 指示服务功能分组是否在界面上显示。,
"showIndex": "0" // 服务功能分组在界面上的显示顺序。,
"createDate": "" // 服务功能分组的创建日期,默认为当前时间。,
"lastUpdate": "" // 服务功能分组的最后更新日期,默认为当前时间。
};
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "post");
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
$response = curl_exec($ch);
curl_close($ch);
echo $response;
|
| using System;
using System.Net.Http;
using System.Threading.Tasks;
using System.Text;
using System.Text.Json;
class Program
{
static async Task Main()
{
using (var client = new HttpClient())
{
client.DefaultRequestHeaders.Add("Authorization", "Bearer {your_access_token}");
HttpResponseMessage response;
var data = {
"id": "0" // 服务功能分组的唯一标识符。,
"providerID": "0" // 关联的服务商的唯一标识符。,
"name": "" // 服务功能分组的名称。,
"code": "" // 服务功能分组的唯一代码,用于系统内部标识。,
"icon": "" // 服务功能分组的图标URL或路径。,
"description": "" // 服务功能分组的详细描述信息。,
"show": false // 指示服务功能分组是否在界面上显示。,
"showIndex": "0" // 服务功能分组在界面上的显示顺序。,
"createDate": "" // 服务功能分组的创建日期,默认为当前时间。,
"lastUpdate": "" // 服务功能分组的最后更新日期,默认为当前时间。
};
var content = new StringContent(
JsonSerializer.Serialize(data),
Encoding.UTF8,
"application/json");
response = await client.postAsync("{server}/AppSetting/{appKey}/Groups", content);
var content = await response.Content.ReadAsStringAsync();
Console.WriteLine(content);
}
}
}
|
| require 'net/http'
require 'json'
uri = URI("{server}/AppSetting/{appKey}/Groups")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::undefined.new(uri)
request["Authorization"] = "Bearer {your_access_token}"
request["Content-Type"] = "application/json"
data = {
"id": "0" // 服务功能分组的唯一标识符。,
"providerID": "0" // 关联的服务商的唯一标识符。,
"name": "" // 服务功能分组的名称。,
"code": "" // 服务功能分组的唯一代码,用于系统内部标识。,
"icon": "" // 服务功能分组的图标URL或路径。,
"description": "" // 服务功能分组的详细描述信息。,
"show": false // 指示服务功能分组是否在界面上显示。,
"showIndex": "0" // 服务功能分组在界面上的显示顺序。,
"createDate": "" // 服务功能分组的创建日期,默认为当前时间。,
"lastUpdate": "" // 服务功能分组的最后更新日期,默认为当前时间。
}
request.set_form_data(data)
response = http.request(request)
puts response.body
|
| const data = {
"id": "0" // 服务功能分组的唯一标识符。,
"providerID": "0" // 关联的服务商的唯一标识符。,
"name": "" // 服务功能分组的名称。,
"code": "" // 服务功能分组的唯一代码,用于系统内部标识。,
"icon": "" // 服务功能分组的图标URL或路径。,
"description": "" // 服务功能分组的详细描述信息。,
"show": false // 指示服务功能分组是否在界面上显示。,
"showIndex": "0" // 服务功能分组在界面上的显示顺序。,
"createDate": "" // 服务功能分组的创建日期,默认为当前时间。,
"lastUpdate": "" // 服务功能分组的最后更新日期,默认为当前时间。
};
fetch("{server}/AppSetting/{appKey}/Groups", {
method: "post",
headers: {
"Authorization": "Bearer {your_access_token}",
'Content-Type': 'application/json'
},
body: JSON.stringify(data)
})
.then(response => response.json())
.catch(error => console.error(error));
|
| import okhttp3.OkHttpClient;
import okhttp3.Request;
import okhttp3.Response;
import okhttp3.MediaType;
import okhttp3.RequestBody;
import org.json.JSONObject;
public class ApiClient {
private final OkHttpClient client = new OkHttpClient();
public void makeRequest() {
Request.Builder requestBuilder = new Request.Builder()
.url("{server}/AppSetting/{appKey}/Groups")
.addHeader("Authorization", "Bearer {your_access_token}")
.addHeader("Content-Type", "application/json");
JSONObject data = {
"id": "0" // 服务功能分组的唯一标识符。,
"providerID": "0" // 关联的服务商的唯一标识符。,
"name": "" // 服务功能分组的名称。,
"code": "" // 服务功能分组的唯一代码,用于系统内部标识。,
"icon": "" // 服务功能分组的图标URL或路径。,
"description": "" // 服务功能分组的详细描述信息。,
"show": false // 指示服务功能分组是否在界面上显示。,
"showIndex": "0" // 服务功能分组在界面上的显示顺序。,
"createDate": "" // 服务功能分组的创建日期,默认为当前时间。,
"lastUpdate": "" // 服务功能分组的最后更新日期,默认为当前时间。
};
RequestBody body = RequestBody.create(
MediaType.parse("application/json"), data.toString());
requestBuilder.method("post", body);
try (Response response = client.newCall(requestBuilder.build()).execute()) {
System.out.println(response.body().string());
} catch (Exception e) {
e.printStackTrace();
}
}
}
|
| import Foundation
let url = URL(string: "{server}/AppSetting/{appKey}/Groups")!
var request = URLRequest(url: url)
request.httpMethod = "post"
request.setValue("Bearer {your_access_token}", forHTTPHeaderField: "Authorization")
request.setValue("application/json", forHTTPHeaderField: "Content-Type")
let data = {
"id": "0" // 服务功能分组的唯一标识符。,
"providerID": "0" // 关联的服务商的唯一标识符。,
"name": "" // 服务功能分组的名称。,
"code": "" // 服务功能分组的唯一代码,用于系统内部标识。,
"icon": "" // 服务功能分组的图标URL或路径。,
"description": "" // 服务功能分组的详细描述信息。,
"show": false // 指示服务功能分组是否在界面上显示。,
"showIndex": "0" // 服务功能分组在界面上的显示顺序。,
"createDate": "" // 服务功能分组的创建日期,默认为当前时间。,
"lastUpdate": "" // 服务功能分组的最后更新日期,默认为当前时间。
}
let jsonData = try? JSONSerialization.data(withJSONObject: data)
request.httpBody = jsonData
let task = URLSession.shared.dataTask(with: request) { data, response, error in
if let data = data {
if let json = try? JSONSerialization.jsonObject(with: data) {
print(json)
}
}
}
task.resume()
|
返回结果
| {
"code": 200 // 状态码,
"data": {
"id": "0"
},
"error": "" // 错误信息
}
|
获取服务分组详情
基本信息
- 接口名称:获取服务分组详情
- 请求方式:GET
- 请求路径:/AppSetting/{appKey}/Groups/{id}
请求参数
Path 参数
参数名 |
示例值 |
参数描述 |
是否必填 |
id |
- |
服务分组ID |
是 |
appKey |
- |
- |
是 |
示例代码
| import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.net.URI;
import com.fasterxml.jackson.databind.ObjectMapper;
import java.util.Map;
public class ApiClient {
public static void main(String[] args) {
HttpClient client = HttpClient.newHttpClient();
HttpRequest.Builder requestBuilder = HttpRequest.newBuilder()
.uri(URI.create("{server}/AppSetting/{appKey}/Groups/{id}"))
.header("Authorization", "Bearer {your_access_token}");
requestBuilder.method("get", HttpRequest.BodyPublishers.noBody());
try {
HttpResponse<String> response = client.send(requestBuilder.build(), HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
} catch (Exception e) {
e.printStackTrace();
}
}
}
|
| import requests
url = "{server}/AppSetting/{appKey}/Groups/{id}"
headers = {
"Authorization": "Bearer {your_access_token}"
}
response = requests.get(
url,
headers=headers
)
print(response.json())
|
| package main
import (
"fmt"
"io/ioutil"
"net/http"
"bytes"
"encoding/json"
)
func main() {
client := &http.Client{}
var req *http.Request
var err error
req, err = http.NewRequest("get", "{server}/AppSetting/{appKey}/Groups/{id}", nil)
if err != nil {
panic(err)
}
req.Header.Add("Authorization", "Bearer {your_access_token}")
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
body, err := ioutil.ReadAll(resp.Body)
if err != nil {
panic(err)
}
fmt.Println(string(body))
}
|
| const axios = require('axios');
const config = {
method: 'get',
url: '{server}/AppSetting/{appKey}/Groups/{id}',
headers: {
'Authorization': 'Bearer {your_access_token}'
}
};
axios(config)
.then(response => {
console.log(response.data);
})
.catch(error => {
console.error(error);
});
|
| <?php
$url = "{server}/AppSetting/{appKey}/Groups/{id}";
$headers = [
"Authorization: Bearer {your_access_token}"
];
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "get");
$response = curl_exec($ch);
curl_close($ch);
echo $response;
|
| using System;
using System.Net.Http;
using System.Threading.Tasks;
using System.Text;
using System.Text.Json;
class Program
{
static async Task Main()
{
using (var client = new HttpClient())
{
client.DefaultRequestHeaders.Add("Authorization", "Bearer {your_access_token}");
HttpResponseMessage response;
response = await client.getAsync("{server}/AppSetting/{appKey}/Groups/{id}");
var content = await response.Content.ReadAsStringAsync();
Console.WriteLine(content);
}
}
}
|
| require 'net/http'
require 'json'
uri = URI("{server}/AppSetting/{appKey}/Groups/{id}")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::undefined.new(uri)
request["Authorization"] = "Bearer {your_access_token}"
response = http.request(request)
puts response.body
|
| fetch("{server}/AppSetting/{appKey}/Groups/{id}", {
method: "get",
headers: {
"Authorization": "Bearer {your_access_token}"
}
})
.then(response => response.json())
.catch(error => console.error(error));
|
| import okhttp3.OkHttpClient;
import okhttp3.Request;
import okhttp3.Response;
import okhttp3.MediaType;
import okhttp3.RequestBody;
import org.json.JSONObject;
public class ApiClient {
private final OkHttpClient client = new OkHttpClient();
public void makeRequest() {
Request.Builder requestBuilder = new Request.Builder()
.url("{server}/AppSetting/{appKey}/Groups/{id}")
.addHeader("Authorization", "Bearer {your_access_token}");
requestBuilder.method("get", null);
try (Response response = client.newCall(requestBuilder.build()).execute()) {
System.out.println(response.body().string());
} catch (Exception e) {
e.printStackTrace();
}
}
}
|
| import Foundation
let url = URL(string: "{server}/AppSetting/{appKey}/Groups/{id}")!
var request = URLRequest(url: url)
request.httpMethod = "get"
request.setValue("Bearer {your_access_token}", forHTTPHeaderField: "Authorization")
request.setValue("application/json", forHTTPHeaderField: "Content-Type")
let task = URLSession.shared.dataTask(with: request) { data, response, error in
if let data = data {
if let json = try? JSONSerialization.jsonObject(with: data) {
print(json)
}
}
}
task.resume()
|
返回结果
| {
"code": 200 // 状态码,
"data": {
"id": "0" // 服务功能分组的唯一标识符。,
"providerID": "0" // 关联的服务商的唯一标识符。,
"name": "" // 服务功能分组的名称。,
"code": "" // 服务功能分组的唯一代码,用于系统内部标识。,
"icon": "" // 服务功能分组的图标URL或路径。,
"description": "" // 服务功能分组的详细描述信息。,
"show": false // 指示服务功能分组是否在界面上显示。,
"showIndex": "0" // 服务功能分组在界面上的显示顺序。,
"createDate": "" // 服务功能分组的创建日期,默认为当前时间。,
"lastUpdate": "" // 服务功能分组的最后更新日期,默认为当前时间。
},
"error": "" // 错误信息
}
|
字段名 |
类型 |
描述 |
是否必填 |
code |
integer |
状态码 |
否 |
data |
ServiceGroup |
- |
否 |
error |
string |
错误信息 |
否 |
更新服务分组
基本信息
- 接口名称:更新服务分组
- 请求方式:PUT
- 请求路径:/AppSetting/{appKey}/Groups/{id}
请求参数
Path 参数
参数名 |
示例值 |
参数描述 |
是否必填 |
id |
- |
服务分组ID |
是 |
appKey |
- |
- |
是 |
Body 参数
参数名 |
类型 |
示例值 |
参数描述 |
是否必填 |
id |
integer |
- |
服务功能分组的唯一标识符。 |
否 |
providerID |
integer |
- |
关联的服务商的唯一标识符。 |
否 |
name |
string |
- |
服务功能分组的名称。 |
否 |
code |
string |
- |
服务功能分组的唯一代码,用于系统内部标识。 |
否 |
icon |
string |
- |
服务功能分组的图标URL或路径。 |
否 |
description |
string |
- |
服务功能分组的详细描述信息。 |
否 |
show |
boolean |
- |
指示服务功能分组是否在界面上显示。 |
否 |
showIndex |
integer |
- |
服务功能分组在界面上的显示顺序。 |
否 |
createDate |
string |
- |
服务功能分组的创建日期,默认为当前时间。 |
否 |
lastUpdate |
string |
- |
服务功能分组的最后更新日期,默认为当前时间。 |
否 |
示例代码
| import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.net.URI;
import com.fasterxml.jackson.databind.ObjectMapper;
import java.util.Map;
public class ApiClient {
public static void main(String[] args) {
HttpClient client = HttpClient.newHttpClient();
HttpRequest.Builder requestBuilder = HttpRequest.newBuilder()
.uri(URI.create("{server}/AppSetting/{appKey}/Groups/{id}"))
.header("Authorization", "Bearer {your_access_token}")
.header("Content-Type", "application/json");
// 创建请求体数据
Map<String, Object> data = {
"id": "0" // 服务功能分组的唯一标识符。,
"providerID": "0" // 关联的服务商的唯一标识符。,
"name": "" // 服务功能分组的名称。,
"code": "" // 服务功能分组的唯一代码,用于系统内部标识。,
"icon": "" // 服务功能分组的图标URL或路径。,
"description": "" // 服务功能分组的详细描述信息。,
"show": false // 指示服务功能分组是否在界面上显示。,
"showIndex": "0" // 服务功能分组在界面上的显示顺序。,
"createDate": "" // 服务功能分组的创建日期,默认为当前时间。,
"lastUpdate": "" // 服务功能分组的最后更新日期,默认为当前时间。
};
ObjectMapper mapper = new ObjectMapper();
String jsonBody = mapper.writeValueAsString(data);
RequestBody body = RequestBody.create(
MediaType.parse("application/json"), jsonBody);
requestBuilder.method("put", HttpRequest.BodyPublishers.ofString(jsonBody));
try {
HttpResponse<String> response = client.send(requestBuilder.build(), HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
} catch (Exception e) {
e.printStackTrace();
}
}
}
|
| import requests
url = "{server}/AppSetting/{appKey}/Groups/{id}"
headers = {
"Authorization": "Bearer {your_access_token}",
"Content-Type": "application/json"
}
data = {
"id": "0" // 服务功能分组的唯一标识符。,
"providerID": "0" // 关联的服务商的唯一标识符。,
"name": "" // 服务功能分组的名称。,
"code": "" // 服务功能分组的唯一代码,用于系统内部标识。,
"icon": "" // 服务功能分组的图标URL或路径。,
"description": "" // 服务功能分组的详细描述信息。,
"show": false // 指示服务功能分组是否在界面上显示。,
"showIndex": "0" // 服务功能分组在界面上的显示顺序。,
"createDate": "" // 服务功能分组的创建日期,默认为当前时间。,
"lastUpdate": "" // 服务功能分组的最后更新日期,默认为当前时间。
}
response = requests.put(
url,
headers=headers,
json=data
)
print(response.json())
|
| package main
import (
"fmt"
"io/ioutil"
"net/http"
"bytes"
"encoding/json"
)
func main() {
client := &http.Client{}
var req *http.Request
var err error
data := {
"id": "0" // 服务功能分组的唯一标识符。,
"providerID": "0" // 关联的服务商的唯一标识符。,
"name": "" // 服务功能分组的名称。,
"code": "" // 服务功能分组的唯一代码,用于系统内部标识。,
"icon": "" // 服务功能分组的图标URL或路径。,
"description": "" // 服务功能分组的详细描述信息。,
"show": false // 指示服务功能分组是否在界面上显示。,
"showIndex": "0" // 服务功能分组在界面上的显示顺序。,
"createDate": "" // 服务功能分组的创建日期,默认为当前时间。,
"lastUpdate": "" // 服务功能分组的最后更新日期,默认为当前时间。
}
jsonBody, err := json.Marshal(data)
if err != nil {
panic(err)
}
req, err = http.NewRequest("put", "{server}/AppSetting/{appKey}/Groups/{id}", bytes.NewBuffer(jsonBody))
if err != nil {
panic(err)
}
req.Header.Set("Content-Type", "application/json")
req.Header.Add("Authorization", "Bearer {your_access_token}")
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
body, err := ioutil.ReadAll(resp.Body)
if err != nil {
panic(err)
}
fmt.Println(string(body))
}
|
| const axios = require('axios');
const data = {
"id": "0" // 服务功能分组的唯一标识符。,
"providerID": "0" // 关联的服务商的唯一标识符。,
"name": "" // 服务功能分组的名称。,
"code": "" // 服务功能分组的唯一代码,用于系统内部标识。,
"icon": "" // 服务功能分组的图标URL或路径。,
"description": "" // 服务功能分组的详细描述信息。,
"show": false // 指示服务功能分组是否在界面上显示。,
"showIndex": "0" // 服务功能分组在界面上的显示顺序。,
"createDate": "" // 服务功能分组的创建日期,默认为当前时间。,
"lastUpdate": "" // 服务功能分组的最后更新日期,默认为当前时间。
};
const config = {
method: 'put',
url: '{server}/AppSetting/{appKey}/Groups/{id}',
headers: {
'Authorization': 'Bearer {your_access_token}',
'Content-Type': 'application/json'
},
data: data
};
axios(config)
.then(response => {
console.log(response.data);
})
.catch(error => {
console.error(error);
});
|
| <?php
$url = "{server}/AppSetting/{appKey}/Groups/{id}";
$headers = [
"Authorization: Bearer {your_access_token}",
"Content-Type: application/json"
];
$data = {
"id": "0" // 服务功能分组的唯一标识符。,
"providerID": "0" // 关联的服务商的唯一标识符。,
"name": "" // 服务功能分组的名称。,
"code": "" // 服务功能分组的唯一代码,用于系统内部标识。,
"icon": "" // 服务功能分组的图标URL或路径。,
"description": "" // 服务功能分组的详细描述信息。,
"show": false // 指示服务功能分组是否在界面上显示。,
"showIndex": "0" // 服务功能分组在界面上的显示顺序。,
"createDate": "" // 服务功能分组的创建日期,默认为当前时间。,
"lastUpdate": "" // 服务功能分组的最后更新日期,默认为当前时间。
};
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "put");
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
$response = curl_exec($ch);
curl_close($ch);
echo $response;
|
| using System;
using System.Net.Http;
using System.Threading.Tasks;
using System.Text;
using System.Text.Json;
class Program
{
static async Task Main()
{
using (var client = new HttpClient())
{
client.DefaultRequestHeaders.Add("Authorization", "Bearer {your_access_token}");
HttpResponseMessage response;
var data = {
"id": "0" // 服务功能分组的唯一标识符。,
"providerID": "0" // 关联的服务商的唯一标识符。,
"name": "" // 服务功能分组的名称。,
"code": "" // 服务功能分组的唯一代码,用于系统内部标识。,
"icon": "" // 服务功能分组的图标URL或路径。,
"description": "" // 服务功能分组的详细描述信息。,
"show": false // 指示服务功能分组是否在界面上显示。,
"showIndex": "0" // 服务功能分组在界面上的显示顺序。,
"createDate": "" // 服务功能分组的创建日期,默认为当前时间。,
"lastUpdate": "" // 服务功能分组的最后更新日期,默认为当前时间。
};
var content = new StringContent(
JsonSerializer.Serialize(data),
Encoding.UTF8,
"application/json");
response = await client.putAsync("{server}/AppSetting/{appKey}/Groups/{id}", content);
var content = await response.Content.ReadAsStringAsync();
Console.WriteLine(content);
}
}
}
|
| require 'net/http'
require 'json'
uri = URI("{server}/AppSetting/{appKey}/Groups/{id}")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::undefined.new(uri)
request["Authorization"] = "Bearer {your_access_token}"
request["Content-Type"] = "application/json"
data = {
"id": "0" // 服务功能分组的唯一标识符。,
"providerID": "0" // 关联的服务商的唯一标识符。,
"name": "" // 服务功能分组的名称。,
"code": "" // 服务功能分组的唯一代码,用于系统内部标识。,
"icon": "" // 服务功能分组的图标URL或路径。,
"description": "" // 服务功能分组的详细描述信息。,
"show": false // 指示服务功能分组是否在界面上显示。,
"showIndex": "0" // 服务功能分组在界面上的显示顺序。,
"createDate": "" // 服务功能分组的创建日期,默认为当前时间。,
"lastUpdate": "" // 服务功能分组的最后更新日期,默认为当前时间。
}
request.set_form_data(data)
response = http.request(request)
puts response.body
|
| const data = {
"id": "0" // 服务功能分组的唯一标识符。,
"providerID": "0" // 关联的服务商的唯一标识符。,
"name": "" // 服务功能分组的名称。,
"code": "" // 服务功能分组的唯一代码,用于系统内部标识。,
"icon": "" // 服务功能分组的图标URL或路径。,
"description": "" // 服务功能分组的详细描述信息。,
"show": false // 指示服务功能分组是否在界面上显示。,
"showIndex": "0" // 服务功能分组在界面上的显示顺序。,
"createDate": "" // 服务功能分组的创建日期,默认为当前时间。,
"lastUpdate": "" // 服务功能分组的最后更新日期,默认为当前时间。
};
fetch("{server}/AppSetting/{appKey}/Groups/{id}", {
method: "put",
headers: {
"Authorization": "Bearer {your_access_token}",
'Content-Type': 'application/json'
},
body: JSON.stringify(data)
})
.then(response => response.json())
.catch(error => console.error(error));
|
| import okhttp3.OkHttpClient;
import okhttp3.Request;
import okhttp3.Response;
import okhttp3.MediaType;
import okhttp3.RequestBody;
import org.json.JSONObject;
public class ApiClient {
private final OkHttpClient client = new OkHttpClient();
public void makeRequest() {
Request.Builder requestBuilder = new Request.Builder()
.url("{server}/AppSetting/{appKey}/Groups/{id}")
.addHeader("Authorization", "Bearer {your_access_token}")
.addHeader("Content-Type", "application/json");
JSONObject data = {
"id": "0" // 服务功能分组的唯一标识符。,
"providerID": "0" // 关联的服务商的唯一标识符。,
"name": "" // 服务功能分组的名称。,
"code": "" // 服务功能分组的唯一代码,用于系统内部标识。,
"icon": "" // 服务功能分组的图标URL或路径。,
"description": "" // 服务功能分组的详细描述信息。,
"show": false // 指示服务功能分组是否在界面上显示。,
"showIndex": "0" // 服务功能分组在界面上的显示顺序。,
"createDate": "" // 服务功能分组的创建日期,默认为当前时间。,
"lastUpdate": "" // 服务功能分组的最后更新日期,默认为当前时间。
};
RequestBody body = RequestBody.create(
MediaType.parse("application/json"), data.toString());
requestBuilder.method("put", body);
try (Response response = client.newCall(requestBuilder.build()).execute()) {
System.out.println(response.body().string());
} catch (Exception e) {
e.printStackTrace();
}
}
}
|
| import Foundation
let url = URL(string: "{server}/AppSetting/{appKey}/Groups/{id}")!
var request = URLRequest(url: url)
request.httpMethod = "put"
request.setValue("Bearer {your_access_token}", forHTTPHeaderField: "Authorization")
request.setValue("application/json", forHTTPHeaderField: "Content-Type")
let data = {
"id": "0" // 服务功能分组的唯一标识符。,
"providerID": "0" // 关联的服务商的唯一标识符。,
"name": "" // 服务功能分组的名称。,
"code": "" // 服务功能分组的唯一代码,用于系统内部标识。,
"icon": "" // 服务功能分组的图标URL或路径。,
"description": "" // 服务功能分组的详细描述信息。,
"show": false // 指示服务功能分组是否在界面上显示。,
"showIndex": "0" // 服务功能分组在界面上的显示顺序。,
"createDate": "" // 服务功能分组的创建日期,默认为当前时间。,
"lastUpdate": "" // 服务功能分组的最后更新日期,默认为当前时间。
}
let jsonData = try? JSONSerialization.data(withJSONObject: data)
request.httpBody = jsonData
let task = URLSession.shared.dataTask(with: request) { data, response, error in
if let data = data {
if let json = try? JSONSerialization.jsonObject(with: data) {
print(json)
}
}
}
task.resume()
|
返回结果
| {
"code": 200 // 状态码,
"data": false // 响应数据,
"error": "" // 错误信息
}
|
字段名 |
类型 |
描述 |
是否必填 |
code |
integer |
状态码 |
否 |
data |
boolean |
响应数据 |
否 |
error |
string |
错误信息 |
否 |
删除服务分组
基本信息
- 接口名称:删除服务分组
- 请求方式:DELETE
- 请求路径:/AppSetting/{appKey}/Groups/{id}
请求参数
Path 参数
参数名 |
示例值 |
参数描述 |
是否必填 |
id |
- |
服务分组ID |
是 |
appKey |
- |
- |
是 |
示例代码
| import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.net.URI;
import com.fasterxml.jackson.databind.ObjectMapper;
import java.util.Map;
public class ApiClient {
public static void main(String[] args) {
HttpClient client = HttpClient.newHttpClient();
HttpRequest.Builder requestBuilder = HttpRequest.newBuilder()
.uri(URI.create("{server}/AppSetting/{appKey}/Groups/{id}"))
.header("Authorization", "Bearer {your_access_token}");
requestBuilder.method("delete", HttpRequest.BodyPublishers.noBody());
try {
HttpResponse<String> response = client.send(requestBuilder.build(), HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
} catch (Exception e) {
e.printStackTrace();
}
}
}
|
| import requests
url = "{server}/AppSetting/{appKey}/Groups/{id}"
headers = {
"Authorization": "Bearer {your_access_token}"
}
response = requests.delete(
url,
headers=headers
)
print(response.json())
|
| package main
import (
"fmt"
"io/ioutil"
"net/http"
"bytes"
"encoding/json"
)
func main() {
client := &http.Client{}
var req *http.Request
var err error
req, err = http.NewRequest("delete", "{server}/AppSetting/{appKey}/Groups/{id}", nil)
if err != nil {
panic(err)
}
req.Header.Add("Authorization", "Bearer {your_access_token}")
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
body, err := ioutil.ReadAll(resp.Body)
if err != nil {
panic(err)
}
fmt.Println(string(body))
}
|
| const axios = require('axios');
const config = {
method: 'delete',
url: '{server}/AppSetting/{appKey}/Groups/{id}',
headers: {
'Authorization': 'Bearer {your_access_token}'
}
};
axios(config)
.then(response => {
console.log(response.data);
})
.catch(error => {
console.error(error);
});
|
| <?php
$url = "{server}/AppSetting/{appKey}/Groups/{id}";
$headers = [
"Authorization: Bearer {your_access_token}"
];
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "delete");
$response = curl_exec($ch);
curl_close($ch);
echo $response;
|
| using System;
using System.Net.Http;
using System.Threading.Tasks;
using System.Text;
using System.Text.Json;
class Program
{
static async Task Main()
{
using (var client = new HttpClient())
{
client.DefaultRequestHeaders.Add("Authorization", "Bearer {your_access_token}");
HttpResponseMessage response;
response = await client.deleteAsync("{server}/AppSetting/{appKey}/Groups/{id}");
var content = await response.Content.ReadAsStringAsync();
Console.WriteLine(content);
}
}
}
|
| require 'net/http'
require 'json'
uri = URI("{server}/AppSetting/{appKey}/Groups/{id}")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::undefined.new(uri)
request["Authorization"] = "Bearer {your_access_token}"
response = http.request(request)
puts response.body
|
| fetch("{server}/AppSetting/{appKey}/Groups/{id}", {
method: "delete",
headers: {
"Authorization": "Bearer {your_access_token}"
}
})
.then(response => response.json())
.catch(error => console.error(error));
|
| import okhttp3.OkHttpClient;
import okhttp3.Request;
import okhttp3.Response;
import okhttp3.MediaType;
import okhttp3.RequestBody;
import org.json.JSONObject;
public class ApiClient {
private final OkHttpClient client = new OkHttpClient();
public void makeRequest() {
Request.Builder requestBuilder = new Request.Builder()
.url("{server}/AppSetting/{appKey}/Groups/{id}")
.addHeader("Authorization", "Bearer {your_access_token}");
requestBuilder.method("delete", null);
try (Response response = client.newCall(requestBuilder.build()).execute()) {
System.out.println(response.body().string());
} catch (Exception e) {
e.printStackTrace();
}
}
}
|
| import Foundation
let url = URL(string: "{server}/AppSetting/{appKey}/Groups/{id}")!
var request = URLRequest(url: url)
request.httpMethod = "delete"
request.setValue("Bearer {your_access_token}", forHTTPHeaderField: "Authorization")
request.setValue("application/json", forHTTPHeaderField: "Content-Type")
let task = URLSession.shared.dataTask(with: request) { data, response, error in
if let data = data {
if let json = try? JSONSerialization.jsonObject(with: data) {
print(json)
}
}
}
task.resume()
|
返回结果
| {
"code": 200 // 状态码,
"data": false // 响应数据,
"error": "" // 错误信息
}
|
字段名 |
类型 |
描述 |
是否必填 |
code |
integer |
状态码 |
否 |
data |
boolean |
响应数据 |
否 |
error |
string |
错误信息 |
否 |
服务配置项列表
接口说明
根据业务代码、服务商代码、分组代码和显示标志获取服务配置项列表
基本信息
- 接口名称:服务配置项列表
- 请求方式:GET
- 请求路径:/AppSetting/{appKey}/Items
请求参数
Path 参数
参数名 |
示例值 |
参数描述 |
是否必填 |
appKey |
- |
- |
是 |
Query 参数
参数名 |
类型 |
示例值 |
参数描述 |
是否必填 |
bizCode |
string |
- |
业务代码 |
否 |
providerCode |
string |
- |
服务商代码 |
否 |
groupCode |
string |
- |
分组代码 |
否 |
showFlag |
boolean |
- |
是否显示 |
否 |
示例代码
| import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.net.URI;
import com.fasterxml.jackson.databind.ObjectMapper;
import java.util.Map;
public class ApiClient {
public static void main(String[] args) {
HttpClient client = HttpClient.newHttpClient();
HttpRequest.Builder requestBuilder = HttpRequest.newBuilder()
.uri(URI.create("{server}/AppSetting/{appKey}/Items"))
.header("Authorization", "Bearer {your_access_token}");
requestBuilder.method("get", HttpRequest.BodyPublishers.noBody());
try {
HttpResponse<String> response = client.send(requestBuilder.build(), HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
} catch (Exception e) {
e.printStackTrace();
}
}
}
|
| import requests
url = "{server}/AppSetting/{appKey}/Items"
headers = {
"Authorization": "Bearer {your_access_token}"
}
response = requests.get(
url,
headers=headers
)
print(response.json())
|
| package main
import (
"fmt"
"io/ioutil"
"net/http"
"bytes"
"encoding/json"
)
func main() {
client := &http.Client{}
var req *http.Request
var err error
req, err = http.NewRequest("get", "{server}/AppSetting/{appKey}/Items", nil)
if err != nil {
panic(err)
}
req.Header.Add("Authorization", "Bearer {your_access_token}")
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
body, err := ioutil.ReadAll(resp.Body)
if err != nil {
panic(err)
}
fmt.Println(string(body))
}
|
| const axios = require('axios');
const config = {
method: 'get',
url: '{server}/AppSetting/{appKey}/Items',
headers: {
'Authorization': 'Bearer {your_access_token}'
}
};
axios(config)
.then(response => {
console.log(response.data);
})
.catch(error => {
console.error(error);
});
|
| <?php
$url = "{server}/AppSetting/{appKey}/Items";
$headers = [
"Authorization: Bearer {your_access_token}"
];
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "get");
$response = curl_exec($ch);
curl_close($ch);
echo $response;
|
| using System;
using System.Net.Http;
using System.Threading.Tasks;
using System.Text;
using System.Text.Json;
class Program
{
static async Task Main()
{
using (var client = new HttpClient())
{
client.DefaultRequestHeaders.Add("Authorization", "Bearer {your_access_token}");
HttpResponseMessage response;
response = await client.getAsync("{server}/AppSetting/{appKey}/Items");
var content = await response.Content.ReadAsStringAsync();
Console.WriteLine(content);
}
}
}
|
| require 'net/http'
require 'json'
uri = URI("{server}/AppSetting/{appKey}/Items")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::undefined.new(uri)
request["Authorization"] = "Bearer {your_access_token}"
response = http.request(request)
puts response.body
|
| fetch("{server}/AppSetting/{appKey}/Items", {
method: "get",
headers: {
"Authorization": "Bearer {your_access_token}"
}
})
.then(response => response.json())
.catch(error => console.error(error));
|
| import okhttp3.OkHttpClient;
import okhttp3.Request;
import okhttp3.Response;
import okhttp3.MediaType;
import okhttp3.RequestBody;
import org.json.JSONObject;
public class ApiClient {
private final OkHttpClient client = new OkHttpClient();
public void makeRequest() {
Request.Builder requestBuilder = new Request.Builder()
.url("{server}/AppSetting/{appKey}/Items")
.addHeader("Authorization", "Bearer {your_access_token}");
requestBuilder.method("get", null);
try (Response response = client.newCall(requestBuilder.build()).execute()) {
System.out.println(response.body().string());
} catch (Exception e) {
e.printStackTrace();
}
}
}
|
| import Foundation
let url = URL(string: "{server}/AppSetting/{appKey}/Items")!
var request = URLRequest(url: url)
request.httpMethod = "get"
request.setValue("Bearer {your_access_token}", forHTTPHeaderField: "Authorization")
request.setValue("application/json", forHTTPHeaderField: "Content-Type")
let task = URLSession.shared.dataTask(with: request) { data, response, error in
if let data = data {
if let json = try? JSONSerialization.jsonObject(with: data) {
print(json)
}
}
}
task.resume()
|
返回结果
| {
"code": 200 // 状态码,
"data": [
{
"id": "0" // 服务配置项的唯一标识符。,
"bizCode": "" // 服务配置项所属的业务代码,用于分类管理。,
"providerCode": "" // 关联的服务商代码,用于标识提供该配置项的服务商。,
"groupCode": "" // 服务配置项所属的功能分组代码,用于组织和管理相关配置项。,
"name": "" // 服务配置项的名称,用于描述其功能或用途。,
"code": "" // 服务配置项的唯一代码,用于系统内部标识。,
"valueType": "" // 服务配置项的值类型,例如 'text', 'number', 'boolean' 等。默认为 'text'。,
"icon": "" // 服务配置项的图标URL或路径,用于在界面上显示。,
"valueDefaults": "" // 服务配置项的默认值,当未设置具体值时使用。,
"description": "" // 服务配置项的详细描述信息,用于说明其用途和配置方法。,
"tags": "" // 用于分类或标记服务配置项的标签。,
"isSystem": false // 指示该配置项是否为系统级别的配置项,默认为 false。,
"show": false // 指示服务配置项是否在界面上显示,默认为 true。,
"showIndex": "0" // 服务配置项在界面上的显示顺序。,
"createDate": "" // 服务配置项的创建日期,默认为当前时间。,
"lastUpdate": "" // 服务配置项的最后更新日期,默认为当前时间。
}
] // 响应数据,
"error": "" // 错误信息
}
|
字段名 |
类型 |
描述 |
是否必填 |
code |
integer |
状态码 |
否 |
data |
array<ServiceItem> |
响应数据 |
否 |
error |
string |
错误信息 |
否 |
添加服务配置项
基本信息
- 接口名称:添加服务配置项
- 请求方式:POST
- 请求路径:/AppSetting/{appKey}/Items
请求参数
Path 参数
参数名 |
示例值 |
参数描述 |
是否必填 |
appKey |
- |
- |
是 |
Body 参数
参数名 |
类型 |
示例值 |
参数描述 |
是否必填 |
id |
integer |
- |
服务配置项的唯一标识符。 |
否 |
bizCode |
string |
- |
服务配置项所属的业务代码,用于分类管理。 |
否 |
providerCode |
string |
- |
关联的服务商代码,用于标识提供该配置项的服务商。 |
否 |
groupCode |
string |
- |
服务配置项所属的功能分组代码,用于组织和管理相关配置项。 |
否 |
name |
string |
- |
服务配置项的名称,用于描述其功能或用途。 |
否 |
code |
string |
- |
服务配置项的唯一代码,用于系统内部标识。 |
否 |
valueType |
string |
- |
服务配置项的值类型,例如 'text', 'number', 'boolean' 等。默认为 'text'。 |
否 |
icon |
string |
- |
服务配置项的图标URL或路径,用于在界面上显示。 |
否 |
valueDefaults |
string |
- |
服务配置项的默认值,当未设置具体值时使用。 |
否 |
description |
string |
- |
服务配置项的详细描述信息,用于说明其用途和配置方法。 |
否 |
tags |
string |
- |
用于分类或标记服务配置项的标签。 |
否 |
isSystem |
boolean |
- |
指示该配置项是否为系统级别的配置项,默认为 false。 |
否 |
show |
boolean |
- |
指示服务配置项是否在界面上显示,默认为 true。 |
否 |
showIndex |
integer |
- |
服务配置项在界面上的显示顺序。 |
否 |
createDate |
string |
- |
服务配置项的创建日期,默认为当前时间。 |
否 |
lastUpdate |
string |
- |
服务配置项的最后更新日期,默认为当前时间。 |
否 |
示例代码
| import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.net.URI;
import com.fasterxml.jackson.databind.ObjectMapper;
import java.util.Map;
public class ApiClient {
public static void main(String[] args) {
HttpClient client = HttpClient.newHttpClient();
HttpRequest.Builder requestBuilder = HttpRequest.newBuilder()
.uri(URI.create("{server}/AppSetting/{appKey}/Items"))
.header("Authorization", "Bearer {your_access_token}")
.header("Content-Type", "application/json");
// 创建请求体数据
Map<String, Object> data = {
"id": "0" // 服务配置项的唯一标识符。,
"bizCode": "" // 服务配置项所属的业务代码,用于分类管理。,
"providerCode": "" // 关联的服务商代码,用于标识提供该配置项的服务商。,
"groupCode": "" // 服务配置项所属的功能分组代码,用于组织和管理相关配置项。,
"name": "" // 服务配置项的名称,用于描述其功能或用途。,
"code": "" // 服务配置项的唯一代码,用于系统内部标识。,
"valueType": "" // 服务配置项的值类型,例如 'text', 'number', 'boolean' 等。默认为 'text'。,
"icon": "" // 服务配置项的图标URL或路径,用于在界面上显示。,
"valueDefaults": "" // 服务配置项的默认值,当未设置具体值时使用。,
"description": "" // 服务配置项的详细描述信息,用于说明其用途和配置方法。,
"tags": "" // 用于分类或标记服务配置项的标签。,
"isSystem": false // 指示该配置项是否为系统级别的配置项,默认为 false。,
"show": false // 指示服务配置项是否在界面上显示,默认为 true。,
"showIndex": "0" // 服务配置项在界面上的显示顺序。,
"createDate": "" // 服务配置项的创建日期,默认为当前时间。,
"lastUpdate": "" // 服务配置项的最后更新日期,默认为当前时间。
};
ObjectMapper mapper = new ObjectMapper();
String jsonBody = mapper.writeValueAsString(data);
RequestBody body = RequestBody.create(
MediaType.parse("application/json"), jsonBody);
requestBuilder.method("post", HttpRequest.BodyPublishers.ofString(jsonBody));
try {
HttpResponse<String> response = client.send(requestBuilder.build(), HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
} catch (Exception e) {
e.printStackTrace();
}
}
}
|
| import requests
url = "{server}/AppSetting/{appKey}/Items"
headers = {
"Authorization": "Bearer {your_access_token}",
"Content-Type": "application/json"
}
data = {
"id": "0" // 服务配置项的唯一标识符。,
"bizCode": "" // 服务配置项所属的业务代码,用于分类管理。,
"providerCode": "" // 关联的服务商代码,用于标识提供该配置项的服务商。,
"groupCode": "" // 服务配置项所属的功能分组代码,用于组织和管理相关配置项。,
"name": "" // 服务配置项的名称,用于描述其功能或用途。,
"code": "" // 服务配置项的唯一代码,用于系统内部标识。,
"valueType": "" // 服务配置项的值类型,例如 'text', 'number', 'boolean' 等。默认为 'text'。,
"icon": "" // 服务配置项的图标URL或路径,用于在界面上显示。,
"valueDefaults": "" // 服务配置项的默认值,当未设置具体值时使用。,
"description": "" // 服务配置项的详细描述信息,用于说明其用途和配置方法。,
"tags": "" // 用于分类或标记服务配置项的标签。,
"isSystem": false // 指示该配置项是否为系统级别的配置项,默认为 false。,
"show": false // 指示服务配置项是否在界面上显示,默认为 true。,
"showIndex": "0" // 服务配置项在界面上的显示顺序。,
"createDate": "" // 服务配置项的创建日期,默认为当前时间。,
"lastUpdate": "" // 服务配置项的最后更新日期,默认为当前时间。
}
response = requests.post(
url,
headers=headers,
json=data
)
print(response.json())
|
| package main
import (
"fmt"
"io/ioutil"
"net/http"
"bytes"
"encoding/json"
)
func main() {
client := &http.Client{}
var req *http.Request
var err error
data := {
"id": "0" // 服务配置项的唯一标识符。,
"bizCode": "" // 服务配置项所属的业务代码,用于分类管理。,
"providerCode": "" // 关联的服务商代码,用于标识提供该配置项的服务商。,
"groupCode": "" // 服务配置项所属的功能分组代码,用于组织和管理相关配置项。,
"name": "" // 服务配置项的名称,用于描述其功能或用途。,
"code": "" // 服务配置项的唯一代码,用于系统内部标识。,
"valueType": "" // 服务配置项的值类型,例如 'text', 'number', 'boolean' 等。默认为 'text'。,
"icon": "" // 服务配置项的图标URL或路径,用于在界面上显示。,
"valueDefaults": "" // 服务配置项的默认值,当未设置具体值时使用。,
"description": "" // 服务配置项的详细描述信息,用于说明其用途和配置方法。,
"tags": "" // 用于分类或标记服务配置项的标签。,
"isSystem": false // 指示该配置项是否为系统级别的配置项,默认为 false。,
"show": false // 指示服务配置项是否在界面上显示,默认为 true。,
"showIndex": "0" // 服务配置项在界面上的显示顺序。,
"createDate": "" // 服务配置项的创建日期,默认为当前时间。,
"lastUpdate": "" // 服务配置项的最后更新日期,默认为当前时间。
}
jsonBody, err := json.Marshal(data)
if err != nil {
panic(err)
}
req, err = http.NewRequest("post", "{server}/AppSetting/{appKey}/Items", bytes.NewBuffer(jsonBody))
if err != nil {
panic(err)
}
req.Header.Set("Content-Type", "application/json")
req.Header.Add("Authorization", "Bearer {your_access_token}")
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
body, err := ioutil.ReadAll(resp.Body)
if err != nil {
panic(err)
}
fmt.Println(string(body))
}
|
| const axios = require('axios');
const data = {
"id": "0" // 服务配置项的唯一标识符。,
"bizCode": "" // 服务配置项所属的业务代码,用于分类管理。,
"providerCode": "" // 关联的服务商代码,用于标识提供该配置项的服务商。,
"groupCode": "" // 服务配置项所属的功能分组代码,用于组织和管理相关配置项。,
"name": "" // 服务配置项的名称,用于描述其功能或用途。,
"code": "" // 服务配置项的唯一代码,用于系统内部标识。,
"valueType": "" // 服务配置项的值类型,例如 'text', 'number', 'boolean' 等。默认为 'text'。,
"icon": "" // 服务配置项的图标URL或路径,用于在界面上显示。,
"valueDefaults": "" // 服务配置项的默认值,当未设置具体值时使用。,
"description": "" // 服务配置项的详细描述信息,用于说明其用途和配置方法。,
"tags": "" // 用于分类或标记服务配置项的标签。,
"isSystem": false // 指示该配置项是否为系统级别的配置项,默认为 false。,
"show": false // 指示服务配置项是否在界面上显示,默认为 true。,
"showIndex": "0" // 服务配置项在界面上的显示顺序。,
"createDate": "" // 服务配置项的创建日期,默认为当前时间。,
"lastUpdate": "" // 服务配置项的最后更新日期,默认为当前时间。
};
const config = {
method: 'post',
url: '{server}/AppSetting/{appKey}/Items',
headers: {
'Authorization': 'Bearer {your_access_token}',
'Content-Type': 'application/json'
},
data: data
};
axios(config)
.then(response => {
console.log(response.data);
})
.catch(error => {
console.error(error);
});
|
| <?php
$url = "{server}/AppSetting/{appKey}/Items";
$headers = [
"Authorization: Bearer {your_access_token}",
"Content-Type: application/json"
];
$data = {
"id": "0" // 服务配置项的唯一标识符。,
"bizCode": "" // 服务配置项所属的业务代码,用于分类管理。,
"providerCode": "" // 关联的服务商代码,用于标识提供该配置项的服务商。,
"groupCode": "" // 服务配置项所属的功能分组代码,用于组织和管理相关配置项。,
"name": "" // 服务配置项的名称,用于描述其功能或用途。,
"code": "" // 服务配置项的唯一代码,用于系统内部标识。,
"valueType": "" // 服务配置项的值类型,例如 'text', 'number', 'boolean' 等。默认为 'text'。,
"icon": "" // 服务配置项的图标URL或路径,用于在界面上显示。,
"valueDefaults": "" // 服务配置项的默认值,当未设置具体值时使用。,
"description": "" // 服务配置项的详细描述信息,用于说明其用途和配置方法。,
"tags": "" // 用于分类或标记服务配置项的标签。,
"isSystem": false // 指示该配置项是否为系统级别的配置项,默认为 false。,
"show": false // 指示服务配置项是否在界面上显示,默认为 true。,
"showIndex": "0" // 服务配置项在界面上的显示顺序。,
"createDate": "" // 服务配置项的创建日期,默认为当前时间。,
"lastUpdate": "" // 服务配置项的最后更新日期,默认为当前时间。
};
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "post");
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
$response = curl_exec($ch);
curl_close($ch);
echo $response;
|
| using System;
using System.Net.Http;
using System.Threading.Tasks;
using System.Text;
using System.Text.Json;
class Program
{
static async Task Main()
{
using (var client = new HttpClient())
{
client.DefaultRequestHeaders.Add("Authorization", "Bearer {your_access_token}");
HttpResponseMessage response;
var data = {
"id": "0" // 服务配置项的唯一标识符。,
"bizCode": "" // 服务配置项所属的业务代码,用于分类管理。,
"providerCode": "" // 关联的服务商代码,用于标识提供该配置项的服务商。,
"groupCode": "" // 服务配置项所属的功能分组代码,用于组织和管理相关配置项。,
"name": "" // 服务配置项的名称,用于描述其功能或用途。,
"code": "" // 服务配置项的唯一代码,用于系统内部标识。,
"valueType": "" // 服务配置项的值类型,例如 'text', 'number', 'boolean' 等。默认为 'text'。,
"icon": "" // 服务配置项的图标URL或路径,用于在界面上显示。,
"valueDefaults": "" // 服务配置项的默认值,当未设置具体值时使用。,
"description": "" // 服务配置项的详细描述信息,用于说明其用途和配置方法。,
"tags": "" // 用于分类或标记服务配置项的标签。,
"isSystem": false // 指示该配置项是否为系统级别的配置项,默认为 false。,
"show": false // 指示服务配置项是否在界面上显示,默认为 true。,
"showIndex": "0" // 服务配置项在界面上的显示顺序。,
"createDate": "" // 服务配置项的创建日期,默认为当前时间。,
"lastUpdate": "" // 服务配置项的最后更新日期,默认为当前时间。
};
var content = new StringContent(
JsonSerializer.Serialize(data),
Encoding.UTF8,
"application/json");
response = await client.postAsync("{server}/AppSetting/{appKey}/Items", content);
var content = await response.Content.ReadAsStringAsync();
Console.WriteLine(content);
}
}
}
|
| require 'net/http'
require 'json'
uri = URI("{server}/AppSetting/{appKey}/Items")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::undefined.new(uri)
request["Authorization"] = "Bearer {your_access_token}"
request["Content-Type"] = "application/json"
data = {
"id": "0" // 服务配置项的唯一标识符。,
"bizCode": "" // 服务配置项所属的业务代码,用于分类管理。,
"providerCode": "" // 关联的服务商代码,用于标识提供该配置项的服务商。,
"groupCode": "" // 服务配置项所属的功能分组代码,用于组织和管理相关配置项。,
"name": "" // 服务配置项的名称,用于描述其功能或用途。,
"code": "" // 服务配置项的唯一代码,用于系统内部标识。,
"valueType": "" // 服务配置项的值类型,例如 'text', 'number', 'boolean' 等。默认为 'text'。,
"icon": "" // 服务配置项的图标URL或路径,用于在界面上显示。,
"valueDefaults": "" // 服务配置项的默认值,当未设置具体值时使用。,
"description": "" // 服务配置项的详细描述信息,用于说明其用途和配置方法。,
"tags": "" // 用于分类或标记服务配置项的标签。,
"isSystem": false // 指示该配置项是否为系统级别的配置项,默认为 false。,
"show": false // 指示服务配置项是否在界面上显示,默认为 true。,
"showIndex": "0" // 服务配置项在界面上的显示顺序。,
"createDate": "" // 服务配置项的创建日期,默认为当前时间。,
"lastUpdate": "" // 服务配置项的最后更新日期,默认为当前时间。
}
request.set_form_data(data)
response = http.request(request)
puts response.body
|
| const data = {
"id": "0" // 服务配置项的唯一标识符。,
"bizCode": "" // 服务配置项所属的业务代码,用于分类管理。,
"providerCode": "" // 关联的服务商代码,用于标识提供该配置项的服务商。,
"groupCode": "" // 服务配置项所属的功能分组代码,用于组织和管理相关配置项。,
"name": "" // 服务配置项的名称,用于描述其功能或用途。,
"code": "" // 服务配置项的唯一代码,用于系统内部标识。,
"valueType": "" // 服务配置项的值类型,例如 'text', 'number', 'boolean' 等。默认为 'text'。,
"icon": "" // 服务配置项的图标URL或路径,用于在界面上显示。,
"valueDefaults": "" // 服务配置项的默认值,当未设置具体值时使用。,
"description": "" // 服务配置项的详细描述信息,用于说明其用途和配置方法。,
"tags": "" // 用于分类或标记服务配置项的标签。,
"isSystem": false // 指示该配置项是否为系统级别的配置项,默认为 false。,
"show": false // 指示服务配置项是否在界面上显示,默认为 true。,
"showIndex": "0" // 服务配置项在界面上的显示顺序。,
"createDate": "" // 服务配置项的创建日期,默认为当前时间。,
"lastUpdate": "" // 服务配置项的最后更新日期,默认为当前时间。
};
fetch("{server}/AppSetting/{appKey}/Items", {
method: "post",
headers: {
"Authorization": "Bearer {your_access_token}",
'Content-Type': 'application/json'
},
body: JSON.stringify(data)
})
.then(response => response.json())
.catch(error => console.error(error));
|
| import okhttp3.OkHttpClient;
import okhttp3.Request;
import okhttp3.Response;
import okhttp3.MediaType;
import okhttp3.RequestBody;
import org.json.JSONObject;
public class ApiClient {
private final OkHttpClient client = new OkHttpClient();
public void makeRequest() {
Request.Builder requestBuilder = new Request.Builder()
.url("{server}/AppSetting/{appKey}/Items")
.addHeader("Authorization", "Bearer {your_access_token}")
.addHeader("Content-Type", "application/json");
JSONObject data = {
"id": "0" // 服务配置项的唯一标识符。,
"bizCode": "" // 服务配置项所属的业务代码,用于分类管理。,
"providerCode": "" // 关联的服务商代码,用于标识提供该配置项的服务商。,
"groupCode": "" // 服务配置项所属的功能分组代码,用于组织和管理相关配置项。,
"name": "" // 服务配置项的名称,用于描述其功能或用途。,
"code": "" // 服务配置项的唯一代码,用于系统内部标识。,
"valueType": "" // 服务配置项的值类型,例如 'text', 'number', 'boolean' 等。默认为 'text'。,
"icon": "" // 服务配置项的图标URL或路径,用于在界面上显示。,
"valueDefaults": "" // 服务配置项的默认值,当未设置具体值时使用。,
"description": "" // 服务配置项的详细描述信息,用于说明其用途和配置方法。,
"tags": "" // 用于分类或标记服务配置项的标签。,
"isSystem": false // 指示该配置项是否为系统级别的配置项,默认为 false。,
"show": false // 指示服务配置项是否在界面上显示,默认为 true。,
"showIndex": "0" // 服务配置项在界面上的显示顺序。,
"createDate": "" // 服务配置项的创建日期,默认为当前时间。,
"lastUpdate": "" // 服务配置项的最后更新日期,默认为当前时间。
};
RequestBody body = RequestBody.create(
MediaType.parse("application/json"), data.toString());
requestBuilder.method("post", body);
try (Response response = client.newCall(requestBuilder.build()).execute()) {
System.out.println(response.body().string());
} catch (Exception e) {
e.printStackTrace();
}
}
}
|
| import Foundation
let url = URL(string: "{server}/AppSetting/{appKey}/Items")!
var request = URLRequest(url: url)
request.httpMethod = "post"
request.setValue("Bearer {your_access_token}", forHTTPHeaderField: "Authorization")
request.setValue("application/json", forHTTPHeaderField: "Content-Type")
let data = {
"id": "0" // 服务配置项的唯一标识符。,
"bizCode": "" // 服务配置项所属的业务代码,用于分类管理。,
"providerCode": "" // 关联的服务商代码,用于标识提供该配置项的服务商。,
"groupCode": "" // 服务配置项所属的功能分组代码,用于组织和管理相关配置项。,
"name": "" // 服务配置项的名称,用于描述其功能或用途。,
"code": "" // 服务配置项的唯一代码,用于系统内部标识。,
"valueType": "" // 服务配置项的值类型,例如 'text', 'number', 'boolean' 等。默认为 'text'。,
"icon": "" // 服务配置项的图标URL或路径,用于在界面上显示。,
"valueDefaults": "" // 服务配置项的默认值,当未设置具体值时使用。,
"description": "" // 服务配置项的详细描述信息,用于说明其用途和配置方法。,
"tags": "" // 用于分类或标记服务配置项的标签。,
"isSystem": false // 指示该配置项是否为系统级别的配置项,默认为 false。,
"show": false // 指示服务配置项是否在界面上显示,默认为 true。,
"showIndex": "0" // 服务配置项在界面上的显示顺序。,
"createDate": "" // 服务配置项的创建日期,默认为当前时间。,
"lastUpdate": "" // 服务配置项的最后更新日期,默认为当前时间。
}
let jsonData = try? JSONSerialization.data(withJSONObject: data)
request.httpBody = jsonData
let task = URLSession.shared.dataTask(with: request) { data, response, error in
if let data = data {
if let json = try? JSONSerialization.jsonObject(with: data) {
print(json)
}
}
}
task.resume()
|
返回结果
| {
"code": 200 // 状态码,
"data": {
"id": "0"
},
"error": "" // 错误信息
}
|
服务配置项详情
基本信息
- 接口名称:服务配置项详情
- 请求方式:GET
- 请求路径:/AppSetting/{appKey}/Items/{id}
请求参数
Path 参数
参数名 |
示例值 |
参数描述 |
是否必填 |
id |
- |
服务配置项ID |
是 |
appKey |
- |
- |
是 |
示例代码
| import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.net.URI;
import com.fasterxml.jackson.databind.ObjectMapper;
import java.util.Map;
public class ApiClient {
public static void main(String[] args) {
HttpClient client = HttpClient.newHttpClient();
HttpRequest.Builder requestBuilder = HttpRequest.newBuilder()
.uri(URI.create("{server}/AppSetting/{appKey}/Items/{id}"))
.header("Authorization", "Bearer {your_access_token}");
requestBuilder.method("get", HttpRequest.BodyPublishers.noBody());
try {
HttpResponse<String> response = client.send(requestBuilder.build(), HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
} catch (Exception e) {
e.printStackTrace();
}
}
}
|
| import requests
url = "{server}/AppSetting/{appKey}/Items/{id}"
headers = {
"Authorization": "Bearer {your_access_token}"
}
response = requests.get(
url,
headers=headers
)
print(response.json())
|
| package main
import (
"fmt"
"io/ioutil"
"net/http"
"bytes"
"encoding/json"
)
func main() {
client := &http.Client{}
var req *http.Request
var err error
req, err = http.NewRequest("get", "{server}/AppSetting/{appKey}/Items/{id}", nil)
if err != nil {
panic(err)
}
req.Header.Add("Authorization", "Bearer {your_access_token}")
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
body, err := ioutil.ReadAll(resp.Body)
if err != nil {
panic(err)
}
fmt.Println(string(body))
}
|
| const axios = require('axios');
const config = {
method: 'get',
url: '{server}/AppSetting/{appKey}/Items/{id}',
headers: {
'Authorization': 'Bearer {your_access_token}'
}
};
axios(config)
.then(response => {
console.log(response.data);
})
.catch(error => {
console.error(error);
});
|
| <?php
$url = "{server}/AppSetting/{appKey}/Items/{id}";
$headers = [
"Authorization: Bearer {your_access_token}"
];
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "get");
$response = curl_exec($ch);
curl_close($ch);
echo $response;
|
| using System;
using System.Net.Http;
using System.Threading.Tasks;
using System.Text;
using System.Text.Json;
class Program
{
static async Task Main()
{
using (var client = new HttpClient())
{
client.DefaultRequestHeaders.Add("Authorization", "Bearer {your_access_token}");
HttpResponseMessage response;
response = await client.getAsync("{server}/AppSetting/{appKey}/Items/{id}");
var content = await response.Content.ReadAsStringAsync();
Console.WriteLine(content);
}
}
}
|
| require 'net/http'
require 'json'
uri = URI("{server}/AppSetting/{appKey}/Items/{id}")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::undefined.new(uri)
request["Authorization"] = "Bearer {your_access_token}"
response = http.request(request)
puts response.body
|
| fetch("{server}/AppSetting/{appKey}/Items/{id}", {
method: "get",
headers: {
"Authorization": "Bearer {your_access_token}"
}
})
.then(response => response.json())
.catch(error => console.error(error));
|
| import okhttp3.OkHttpClient;
import okhttp3.Request;
import okhttp3.Response;
import okhttp3.MediaType;
import okhttp3.RequestBody;
import org.json.JSONObject;
public class ApiClient {
private final OkHttpClient client = new OkHttpClient();
public void makeRequest() {
Request.Builder requestBuilder = new Request.Builder()
.url("{server}/AppSetting/{appKey}/Items/{id}")
.addHeader("Authorization", "Bearer {your_access_token}");
requestBuilder.method("get", null);
try (Response response = client.newCall(requestBuilder.build()).execute()) {
System.out.println(response.body().string());
} catch (Exception e) {
e.printStackTrace();
}
}
}
|
| import Foundation
let url = URL(string: "{server}/AppSetting/{appKey}/Items/{id}")!
var request = URLRequest(url: url)
request.httpMethod = "get"
request.setValue("Bearer {your_access_token}", forHTTPHeaderField: "Authorization")
request.setValue("application/json", forHTTPHeaderField: "Content-Type")
let task = URLSession.shared.dataTask(with: request) { data, response, error in
if let data = data {
if let json = try? JSONSerialization.jsonObject(with: data) {
print(json)
}
}
}
task.resume()
|
返回结果
| {
"code": 200 // 状态码,
"data": {
"id": "0" // 服务配置项的唯一标识符。,
"bizCode": "" // 服务配置项所属的业务代码,用于分类管理。,
"providerCode": "" // 关联的服务商代码,用于标识提供该配置项的服务商。,
"groupCode": "" // 服务配置项所属的功能分组代码,用于组织和管理相关配置项。,
"name": "" // 服务配置项的名称,用于描述其功能或用途。,
"code": "" // 服务配置项的唯一代码,用于系统内部标识。,
"valueType": "" // 服务配置项的值类型,例如 'text', 'number', 'boolean' 等。默认为 'text'。,
"icon": "" // 服务配置项的图标URL或路径,用于在界面上显示。,
"valueDefaults": "" // 服务配置项的默认值,当未设置具体值时使用。,
"description": "" // 服务配置项的详细描述信息,用于说明其用途和配置方法。,
"tags": "" // 用于分类或标记服务配置项的标签。,
"isSystem": false // 指示该配置项是否为系统级别的配置项,默认为 false。,
"show": false // 指示服务配置项是否在界面上显示,默认为 true。,
"showIndex": "0" // 服务配置项在界面上的显示顺序。,
"createDate": "" // 服务配置项的创建日期,默认为当前时间。,
"lastUpdate": "" // 服务配置项的最后更新日期,默认为当前时间。
},
"error": "" // 错误信息
}
|
字段名 |
类型 |
描述 |
是否必填 |
code |
integer |
状态码 |
否 |
data |
ServiceItem |
- |
否 |
error |
string |
错误信息 |
否 |
更新服务配置项
基本信息
- 接口名称:更新服务配置项
- 请求方式:PUT
- 请求路径:/AppSetting/{appKey}/Items/{id}
请求参数
Path 参数
参数名 |
示例值 |
参数描述 |
是否必填 |
id |
- |
服务配置项ID |
是 |
appKey |
- |
- |
是 |
Body 参数
参数名 |
类型 |
示例值 |
参数描述 |
是否必填 |
id |
integer |
- |
服务配置项的唯一标识符。 |
否 |
bizCode |
string |
- |
服务配置项所属的业务代码,用于分类管理。 |
否 |
providerCode |
string |
- |
关联的服务商代码,用于标识提供该配置项的服务商。 |
否 |
groupCode |
string |
- |
服务配置项所属的功能分组代码,用于组织和管理相关配置项。 |
否 |
name |
string |
- |
服务配置项的名称,用于描述其功能或用途。 |
否 |
code |
string |
- |
服务配置项的唯一代码,用于系统内部标识。 |
否 |
valueType |
string |
- |
服务配置项的值类型,例如 'text', 'number', 'boolean' 等。默认为 'text'。 |
否 |
icon |
string |
- |
服务配置项的图标URL或路径,用于在界面上显示。 |
否 |
valueDefaults |
string |
- |
服务配置项的默认值,当未设置具体值时使用。 |
否 |
description |
string |
- |
服务配置项的详细描述信息,用于说明其用途和配置方法。 |
否 |
tags |
string |
- |
用于分类或标记服务配置项的标签。 |
否 |
isSystem |
boolean |
- |
指示该配置项是否为系统级别的配置项,默认为 false。 |
否 |
show |
boolean |
- |
指示服务配置项是否在界面上显示,默认为 true。 |
否 |
showIndex |
integer |
- |
服务配置项在界面上的显示顺序。 |
否 |
createDate |
string |
- |
服务配置项的创建日期,默认为当前时间。 |
否 |
lastUpdate |
string |
- |
服务配置项的最后更新日期,默认为当前时间。 |
否 |
示例代码
| import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.net.URI;
import com.fasterxml.jackson.databind.ObjectMapper;
import java.util.Map;
public class ApiClient {
public static void main(String[] args) {
HttpClient client = HttpClient.newHttpClient();
HttpRequest.Builder requestBuilder = HttpRequest.newBuilder()
.uri(URI.create("{server}/AppSetting/{appKey}/Items/{id}"))
.header("Authorization", "Bearer {your_access_token}")
.header("Content-Type", "application/json");
// 创建请求体数据
Map<String, Object> data = {
"id": "0" // 服务配置项的唯一标识符。,
"bizCode": "" // 服务配置项所属的业务代码,用于分类管理。,
"providerCode": "" // 关联的服务商代码,用于标识提供该配置项的服务商。,
"groupCode": "" // 服务配置项所属的功能分组代码,用于组织和管理相关配置项。,
"name": "" // 服务配置项的名称,用于描述其功能或用途。,
"code": "" // 服务配置项的唯一代码,用于系统内部标识。,
"valueType": "" // 服务配置项的值类型,例如 'text', 'number', 'boolean' 等。默认为 'text'。,
"icon": "" // 服务配置项的图标URL或路径,用于在界面上显示。,
"valueDefaults": "" // 服务配置项的默认值,当未设置具体值时使用。,
"description": "" // 服务配置项的详细描述信息,用于说明其用途和配置方法。,
"tags": "" // 用于分类或标记服务配置项的标签。,
"isSystem": false // 指示该配置项是否为系统级别的配置项,默认为 false。,
"show": false // 指示服务配置项是否在界面上显示,默认为 true。,
"showIndex": "0" // 服务配置项在界面上的显示顺序。,
"createDate": "" // 服务配置项的创建日期,默认为当前时间。,
"lastUpdate": "" // 服务配置项的最后更新日期,默认为当前时间。
};
ObjectMapper mapper = new ObjectMapper();
String jsonBody = mapper.writeValueAsString(data);
RequestBody body = RequestBody.create(
MediaType.parse("application/json"), jsonBody);
requestBuilder.method("put", HttpRequest.BodyPublishers.ofString(jsonBody));
try {
HttpResponse<String> response = client.send(requestBuilder.build(), HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
} catch (Exception e) {
e.printStackTrace();
}
}
}
|
| import requests
url = "{server}/AppSetting/{appKey}/Items/{id}"
headers = {
"Authorization": "Bearer {your_access_token}",
"Content-Type": "application/json"
}
data = {
"id": "0" // 服务配置项的唯一标识符。,
"bizCode": "" // 服务配置项所属的业务代码,用于分类管理。,
"providerCode": "" // 关联的服务商代码,用于标识提供该配置项的服务商。,
"groupCode": "" // 服务配置项所属的功能分组代码,用于组织和管理相关配置项。,
"name": "" // 服务配置项的名称,用于描述其功能或用途。,
"code": "" // 服务配置项的唯一代码,用于系统内部标识。,
"valueType": "" // 服务配置项的值类型,例如 'text', 'number', 'boolean' 等。默认为 'text'。,
"icon": "" // 服务配置项的图标URL或路径,用于在界面上显示。,
"valueDefaults": "" // 服务配置项的默认值,当未设置具体值时使用。,
"description": "" // 服务配置项的详细描述信息,用于说明其用途和配置方法。,
"tags": "" // 用于分类或标记服务配置项的标签。,
"isSystem": false // 指示该配置项是否为系统级别的配置项,默认为 false。,
"show": false // 指示服务配置项是否在界面上显示,默认为 true。,
"showIndex": "0" // 服务配置项在界面上的显示顺序。,
"createDate": "" // 服务配置项的创建日期,默认为当前时间。,
"lastUpdate": "" // 服务配置项的最后更新日期,默认为当前时间。
}
response = requests.put(
url,
headers=headers,
json=data
)
print(response.json())
|
| package main
import (
"fmt"
"io/ioutil"
"net/http"
"bytes"
"encoding/json"
)
func main() {
client := &http.Client{}
var req *http.Request
var err error
data := {
"id": "0" // 服务配置项的唯一标识符。,
"bizCode": "" // 服务配置项所属的业务代码,用于分类管理。,
"providerCode": "" // 关联的服务商代码,用于标识提供该配置项的服务商。,
"groupCode": "" // 服务配置项所属的功能分组代码,用于组织和管理相关配置项。,
"name": "" // 服务配置项的名称,用于描述其功能或用途。,
"code": "" // 服务配置项的唯一代码,用于系统内部标识。,
"valueType": "" // 服务配置项的值类型,例如 'text', 'number', 'boolean' 等。默认为 'text'。,
"icon": "" // 服务配置项的图标URL或路径,用于在界面上显示。,
"valueDefaults": "" // 服务配置项的默认值,当未设置具体值时使用。,
"description": "" // 服务配置项的详细描述信息,用于说明其用途和配置方法。,
"tags": "" // 用于分类或标记服务配置项的标签。,
"isSystem": false // 指示该配置项是否为系统级别的配置项,默认为 false。,
"show": false // 指示服务配置项是否在界面上显示,默认为 true。,
"showIndex": "0" // 服务配置项在界面上的显示顺序。,
"createDate": "" // 服务配置项的创建日期,默认为当前时间。,
"lastUpdate": "" // 服务配置项的最后更新日期,默认为当前时间。
}
jsonBody, err := json.Marshal(data)
if err != nil {
panic(err)
}
req, err = http.NewRequest("put", "{server}/AppSetting/{appKey}/Items/{id}", bytes.NewBuffer(jsonBody))
if err != nil {
panic(err)
}
req.Header.Set("Content-Type", "application/json")
req.Header.Add("Authorization", "Bearer {your_access_token}")
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
body, err := ioutil.ReadAll(resp.Body)
if err != nil {
panic(err)
}
fmt.Println(string(body))
}
|
| const axios = require('axios');
const data = {
"id": "0" // 服务配置项的唯一标识符。,
"bizCode": "" // 服务配置项所属的业务代码,用于分类管理。,
"providerCode": "" // 关联的服务商代码,用于标识提供该配置项的服务商。,
"groupCode": "" // 服务配置项所属的功能分组代码,用于组织和管理相关配置项。,
"name": "" // 服务配置项的名称,用于描述其功能或用途。,
"code": "" // 服务配置项的唯一代码,用于系统内部标识。,
"valueType": "" // 服务配置项的值类型,例如 'text', 'number', 'boolean' 等。默认为 'text'。,
"icon": "" // 服务配置项的图标URL或路径,用于在界面上显示。,
"valueDefaults": "" // 服务配置项的默认值,当未设置具体值时使用。,
"description": "" // 服务配置项的详细描述信息,用于说明其用途和配置方法。,
"tags": "" // 用于分类或标记服务配置项的标签。,
"isSystem": false // 指示该配置项是否为系统级别的配置项,默认为 false。,
"show": false // 指示服务配置项是否在界面上显示,默认为 true。,
"showIndex": "0" // 服务配置项在界面上的显示顺序。,
"createDate": "" // 服务配置项的创建日期,默认为当前时间。,
"lastUpdate": "" // 服务配置项的最后更新日期,默认为当前时间。
};
const config = {
method: 'put',
url: '{server}/AppSetting/{appKey}/Items/{id}',
headers: {
'Authorization': 'Bearer {your_access_token}',
'Content-Type': 'application/json'
},
data: data
};
axios(config)
.then(response => {
console.log(response.data);
})
.catch(error => {
console.error(error);
});
|
| <?php
$url = "{server}/AppSetting/{appKey}/Items/{id}";
$headers = [
"Authorization: Bearer {your_access_token}",
"Content-Type: application/json"
];
$data = {
"id": "0" // 服务配置项的唯一标识符。,
"bizCode": "" // 服务配置项所属的业务代码,用于分类管理。,
"providerCode": "" // 关联的服务商代码,用于标识提供该配置项的服务商。,
"groupCode": "" // 服务配置项所属的功能分组代码,用于组织和管理相关配置项。,
"name": "" // 服务配置项的名称,用于描述其功能或用途。,
"code": "" // 服务配置项的唯一代码,用于系统内部标识。,
"valueType": "" // 服务配置项的值类型,例如 'text', 'number', 'boolean' 等。默认为 'text'。,
"icon": "" // 服务配置项的图标URL或路径,用于在界面上显示。,
"valueDefaults": "" // 服务配置项的默认值,当未设置具体值时使用。,
"description": "" // 服务配置项的详细描述信息,用于说明其用途和配置方法。,
"tags": "" // 用于分类或标记服务配置项的标签。,
"isSystem": false // 指示该配置项是否为系统级别的配置项,默认为 false。,
"show": false // 指示服务配置项是否在界面上显示,默认为 true。,
"showIndex": "0" // 服务配置项在界面上的显示顺序。,
"createDate": "" // 服务配置项的创建日期,默认为当前时间。,
"lastUpdate": "" // 服务配置项的最后更新日期,默认为当前时间。
};
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "put");
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
$response = curl_exec($ch);
curl_close($ch);
echo $response;
|
| using System;
using System.Net.Http;
using System.Threading.Tasks;
using System.Text;
using System.Text.Json;
class Program
{
static async Task Main()
{
using (var client = new HttpClient())
{
client.DefaultRequestHeaders.Add("Authorization", "Bearer {your_access_token}");
HttpResponseMessage response;
var data = {
"id": "0" // 服务配置项的唯一标识符。,
"bizCode": "" // 服务配置项所属的业务代码,用于分类管理。,
"providerCode": "" // 关联的服务商代码,用于标识提供该配置项的服务商。,
"groupCode": "" // 服务配置项所属的功能分组代码,用于组织和管理相关配置项。,
"name": "" // 服务配置项的名称,用于描述其功能或用途。,
"code": "" // 服务配置项的唯一代码,用于系统内部标识。,
"valueType": "" // 服务配置项的值类型,例如 'text', 'number', 'boolean' 等。默认为 'text'。,
"icon": "" // 服务配置项的图标URL或路径,用于在界面上显示。,
"valueDefaults": "" // 服务配置项的默认值,当未设置具体值时使用。,
"description": "" // 服务配置项的详细描述信息,用于说明其用途和配置方法。,
"tags": "" // 用于分类或标记服务配置项的标签。,
"isSystem": false // 指示该配置项是否为系统级别的配置项,默认为 false。,
"show": false // 指示服务配置项是否在界面上显示,默认为 true。,
"showIndex": "0" // 服务配置项在界面上的显示顺序。,
"createDate": "" // 服务配置项的创建日期,默认为当前时间。,
"lastUpdate": "" // 服务配置项的最后更新日期,默认为当前时间。
};
var content = new StringContent(
JsonSerializer.Serialize(data),
Encoding.UTF8,
"application/json");
response = await client.putAsync("{server}/AppSetting/{appKey}/Items/{id}", content);
var content = await response.Content.ReadAsStringAsync();
Console.WriteLine(content);
}
}
}
|
| require 'net/http'
require 'json'
uri = URI("{server}/AppSetting/{appKey}/Items/{id}")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::undefined.new(uri)
request["Authorization"] = "Bearer {your_access_token}"
request["Content-Type"] = "application/json"
data = {
"id": "0" // 服务配置项的唯一标识符。,
"bizCode": "" // 服务配置项所属的业务代码,用于分类管理。,
"providerCode": "" // 关联的服务商代码,用于标识提供该配置项的服务商。,
"groupCode": "" // 服务配置项所属的功能分组代码,用于组织和管理相关配置项。,
"name": "" // 服务配置项的名称,用于描述其功能或用途。,
"code": "" // 服务配置项的唯一代码,用于系统内部标识。,
"valueType": "" // 服务配置项的值类型,例如 'text', 'number', 'boolean' 等。默认为 'text'。,
"icon": "" // 服务配置项的图标URL或路径,用于在界面上显示。,
"valueDefaults": "" // 服务配置项的默认值,当未设置具体值时使用。,
"description": "" // 服务配置项的详细描述信息,用于说明其用途和配置方法。,
"tags": "" // 用于分类或标记服务配置项的标签。,
"isSystem": false // 指示该配置项是否为系统级别的配置项,默认为 false。,
"show": false // 指示服务配置项是否在界面上显示,默认为 true。,
"showIndex": "0" // 服务配置项在界面上的显示顺序。,
"createDate": "" // 服务配置项的创建日期,默认为当前时间。,
"lastUpdate": "" // 服务配置项的最后更新日期,默认为当前时间。
}
request.set_form_data(data)
response = http.request(request)
puts response.body
|
| const data = {
"id": "0" // 服务配置项的唯一标识符。,
"bizCode": "" // 服务配置项所属的业务代码,用于分类管理。,
"providerCode": "" // 关联的服务商代码,用于标识提供该配置项的服务商。,
"groupCode": "" // 服务配置项所属的功能分组代码,用于组织和管理相关配置项。,
"name": "" // 服务配置项的名称,用于描述其功能或用途。,
"code": "" // 服务配置项的唯一代码,用于系统内部标识。,
"valueType": "" // 服务配置项的值类型,例如 'text', 'number', 'boolean' 等。默认为 'text'。,
"icon": "" // 服务配置项的图标URL或路径,用于在界面上显示。,
"valueDefaults": "" // 服务配置项的默认值,当未设置具体值时使用。,
"description": "" // 服务配置项的详细描述信息,用于说明其用途和配置方法。,
"tags": "" // 用于分类或标记服务配置项的标签。,
"isSystem": false // 指示该配置项是否为系统级别的配置项,默认为 false。,
"show": false // 指示服务配置项是否在界面上显示,默认为 true。,
"showIndex": "0" // 服务配置项在界面上的显示顺序。,
"createDate": "" // 服务配置项的创建日期,默认为当前时间。,
"lastUpdate": "" // 服务配置项的最后更新日期,默认为当前时间。
};
fetch("{server}/AppSetting/{appKey}/Items/{id}", {
method: "put",
headers: {
"Authorization": "Bearer {your_access_token}",
'Content-Type': 'application/json'
},
body: JSON.stringify(data)
})
.then(response => response.json())
.catch(error => console.error(error));
|
| import okhttp3.OkHttpClient;
import okhttp3.Request;
import okhttp3.Response;
import okhttp3.MediaType;
import okhttp3.RequestBody;
import org.json.JSONObject;
public class ApiClient {
private final OkHttpClient client = new OkHttpClient();
public void makeRequest() {
Request.Builder requestBuilder = new Request.Builder()
.url("{server}/AppSetting/{appKey}/Items/{id}")
.addHeader("Authorization", "Bearer {your_access_token}")
.addHeader("Content-Type", "application/json");
JSONObject data = {
"id": "0" // 服务配置项的唯一标识符。,
"bizCode": "" // 服务配置项所属的业务代码,用于分类管理。,
"providerCode": "" // 关联的服务商代码,用于标识提供该配置项的服务商。,
"groupCode": "" // 服务配置项所属的功能分组代码,用于组织和管理相关配置项。,
"name": "" // 服务配置项的名称,用于描述其功能或用途。,
"code": "" // 服务配置项的唯一代码,用于系统内部标识。,
"valueType": "" // 服务配置项的值类型,例如 'text', 'number', 'boolean' 等。默认为 'text'。,
"icon": "" // 服务配置项的图标URL或路径,用于在界面上显示。,
"valueDefaults": "" // 服务配置项的默认值,当未设置具体值时使用。,
"description": "" // 服务配置项的详细描述信息,用于说明其用途和配置方法。,
"tags": "" // 用于分类或标记服务配置项的标签。,
"isSystem": false // 指示该配置项是否为系统级别的配置项,默认为 false。,
"show": false // 指示服务配置项是否在界面上显示,默认为 true。,
"showIndex": "0" // 服务配置项在界面上的显示顺序。,
"createDate": "" // 服务配置项的创建日期,默认为当前时间。,
"lastUpdate": "" // 服务配置项的最后更新日期,默认为当前时间。
};
RequestBody body = RequestBody.create(
MediaType.parse("application/json"), data.toString());
requestBuilder.method("put", body);
try (Response response = client.newCall(requestBuilder.build()).execute()) {
System.out.println(response.body().string());
} catch (Exception e) {
e.printStackTrace();
}
}
}
|
| import Foundation
let url = URL(string: "{server}/AppSetting/{appKey}/Items/{id}")!
var request = URLRequest(url: url)
request.httpMethod = "put"
request.setValue("Bearer {your_access_token}", forHTTPHeaderField: "Authorization")
request.setValue("application/json", forHTTPHeaderField: "Content-Type")
let data = {
"id": "0" // 服务配置项的唯一标识符。,
"bizCode": "" // 服务配置项所属的业务代码,用于分类管理。,
"providerCode": "" // 关联的服务商代码,用于标识提供该配置项的服务商。,
"groupCode": "" // 服务配置项所属的功能分组代码,用于组织和管理相关配置项。,
"name": "" // 服务配置项的名称,用于描述其功能或用途。,
"code": "" // 服务配置项的唯一代码,用于系统内部标识。,
"valueType": "" // 服务配置项的值类型,例如 'text', 'number', 'boolean' 等。默认为 'text'。,
"icon": "" // 服务配置项的图标URL或路径,用于在界面上显示。,
"valueDefaults": "" // 服务配置项的默认值,当未设置具体值时使用。,
"description": "" // 服务配置项的详细描述信息,用于说明其用途和配置方法。,
"tags": "" // 用于分类或标记服务配置项的标签。,
"isSystem": false // 指示该配置项是否为系统级别的配置项,默认为 false。,
"show": false // 指示服务配置项是否在界面上显示,默认为 true。,
"showIndex": "0" // 服务配置项在界面上的显示顺序。,
"createDate": "" // 服务配置项的创建日期,默认为当前时间。,
"lastUpdate": "" // 服务配置项的最后更新日期,默认为当前时间。
}
let jsonData = try? JSONSerialization.data(withJSONObject: data)
request.httpBody = jsonData
let task = URLSession.shared.dataTask(with: request) { data, response, error in
if let data = data {
if let json = try? JSONSerialization.jsonObject(with: data) {
print(json)
}
}
}
task.resume()
|
返回结果
| {
"code": 200 // 状态码,
"data": false // 响应数据,
"error": "" // 错误信息
}
|
字段名 |
类型 |
描述 |
是否必填 |
code |
integer |
状态码 |
否 |
data |
boolean |
响应数据 |
否 |
error |
string |
错误信息 |
否 |
删除服务配置项
基本信息
- 接口名称:删除服务配置项
- 请求方式:DELETE
- 请求路径:/AppSetting/{appKey}/Items/{id}
请求参数
Path 参数
参数名 |
示例值 |
参数描述 |
是否必填 |
id |
- |
服务配置项ID |
是 |
appKey |
- |
- |
是 |
示例代码
| import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.net.URI;
import com.fasterxml.jackson.databind.ObjectMapper;
import java.util.Map;
public class ApiClient {
public static void main(String[] args) {
HttpClient client = HttpClient.newHttpClient();
HttpRequest.Builder requestBuilder = HttpRequest.newBuilder()
.uri(URI.create("{server}/AppSetting/{appKey}/Items/{id}"))
.header("Authorization", "Bearer {your_access_token}");
requestBuilder.method("delete", HttpRequest.BodyPublishers.noBody());
try {
HttpResponse<String> response = client.send(requestBuilder.build(), HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
} catch (Exception e) {
e.printStackTrace();
}
}
}
|
| import requests
url = "{server}/AppSetting/{appKey}/Items/{id}"
headers = {
"Authorization": "Bearer {your_access_token}"
}
response = requests.delete(
url,
headers=headers
)
print(response.json())
|
| package main
import (
"fmt"
"io/ioutil"
"net/http"
"bytes"
"encoding/json"
)
func main() {
client := &http.Client{}
var req *http.Request
var err error
req, err = http.NewRequest("delete", "{server}/AppSetting/{appKey}/Items/{id}", nil)
if err != nil {
panic(err)
}
req.Header.Add("Authorization", "Bearer {your_access_token}")
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
body, err := ioutil.ReadAll(resp.Body)
if err != nil {
panic(err)
}
fmt.Println(string(body))
}
|
| const axios = require('axios');
const config = {
method: 'delete',
url: '{server}/AppSetting/{appKey}/Items/{id}',
headers: {
'Authorization': 'Bearer {your_access_token}'
}
};
axios(config)
.then(response => {
console.log(response.data);
})
.catch(error => {
console.error(error);
});
|
| <?php
$url = "{server}/AppSetting/{appKey}/Items/{id}";
$headers = [
"Authorization: Bearer {your_access_token}"
];
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "delete");
$response = curl_exec($ch);
curl_close($ch);
echo $response;
|
| using System;
using System.Net.Http;
using System.Threading.Tasks;
using System.Text;
using System.Text.Json;
class Program
{
static async Task Main()
{
using (var client = new HttpClient())
{
client.DefaultRequestHeaders.Add("Authorization", "Bearer {your_access_token}");
HttpResponseMessage response;
response = await client.deleteAsync("{server}/AppSetting/{appKey}/Items/{id}");
var content = await response.Content.ReadAsStringAsync();
Console.WriteLine(content);
}
}
}
|
| require 'net/http'
require 'json'
uri = URI("{server}/AppSetting/{appKey}/Items/{id}")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::undefined.new(uri)
request["Authorization"] = "Bearer {your_access_token}"
response = http.request(request)
puts response.body
|
| fetch("{server}/AppSetting/{appKey}/Items/{id}", {
method: "delete",
headers: {
"Authorization": "Bearer {your_access_token}"
}
})
.then(response => response.json())
.catch(error => console.error(error));
|
| import okhttp3.OkHttpClient;
import okhttp3.Request;
import okhttp3.Response;
import okhttp3.MediaType;
import okhttp3.RequestBody;
import org.json.JSONObject;
public class ApiClient {
private final OkHttpClient client = new OkHttpClient();
public void makeRequest() {
Request.Builder requestBuilder = new Request.Builder()
.url("{server}/AppSetting/{appKey}/Items/{id}")
.addHeader("Authorization", "Bearer {your_access_token}");
requestBuilder.method("delete", null);
try (Response response = client.newCall(requestBuilder.build()).execute()) {
System.out.println(response.body().string());
} catch (Exception e) {
e.printStackTrace();
}
}
}
|
| import Foundation
let url = URL(string: "{server}/AppSetting/{appKey}/Items/{id}")!
var request = URLRequest(url: url)
request.httpMethod = "delete"
request.setValue("Bearer {your_access_token}", forHTTPHeaderField: "Authorization")
request.setValue("application/json", forHTTPHeaderField: "Content-Type")
let task = URLSession.shared.dataTask(with: request) { data, response, error in
if let data = data {
if let json = try? JSONSerialization.jsonObject(with: data) {
print(json)
}
}
}
task.resume()
|
返回结果
| {
"code": 200 // 状态码,
"data": false // 响应数据,
"error": "" // 错误信息
}
|
字段名 |
类型 |
描述 |
是否必填 |
code |
integer |
状态码 |
否 |
data |
boolean |
响应数据 |
否 |
error |
string |
错误信息 |
否 |
配置列表
接口说明
根据服务商代码、分组代码、标签和配置项代码获取配置列表
基本信息
- 接口名称:配置列表
- 请求方式:GET
- 请求路径:/AppSetting/{appKey}
请求参数
Path 参数
参数名 |
示例值 |
参数描述 |
是否必填 |
appKey |
- |
- |
是 |
Query 参数
参数名 |
类型 |
示例值 |
参数描述 |
是否必填 |
providerCode |
string |
- |
服务商代码 |
否 |
groupCode |
string |
- |
分组代码 |
否 |
tag |
string |
- |
标签 |
否 |
code |
string |
- |
配置项代码 |
否 |
示例代码
| import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.net.URI;
import com.fasterxml.jackson.databind.ObjectMapper;
import java.util.Map;
public class ApiClient {
public static void main(String[] args) {
HttpClient client = HttpClient.newHttpClient();
HttpRequest.Builder requestBuilder = HttpRequest.newBuilder()
.uri(URI.create("{server}/AppSetting/{appKey}"))
.header("Authorization", "Bearer {your_access_token}");
requestBuilder.method("get", HttpRequest.BodyPublishers.noBody());
try {
HttpResponse<String> response = client.send(requestBuilder.build(), HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
} catch (Exception e) {
e.printStackTrace();
}
}
}
|
| import requests
url = "{server}/AppSetting/{appKey}"
headers = {
"Authorization": "Bearer {your_access_token}"
}
response = requests.get(
url,
headers=headers
)
print(response.json())
|
| package main
import (
"fmt"
"io/ioutil"
"net/http"
"bytes"
"encoding/json"
)
func main() {
client := &http.Client{}
var req *http.Request
var err error
req, err = http.NewRequest("get", "{server}/AppSetting/{appKey}", nil)
if err != nil {
panic(err)
}
req.Header.Add("Authorization", "Bearer {your_access_token}")
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
body, err := ioutil.ReadAll(resp.Body)
if err != nil {
panic(err)
}
fmt.Println(string(body))
}
|
| const axios = require('axios');
const config = {
method: 'get',
url: '{server}/AppSetting/{appKey}',
headers: {
'Authorization': 'Bearer {your_access_token}'
}
};
axios(config)
.then(response => {
console.log(response.data);
})
.catch(error => {
console.error(error);
});
|
| <?php
$url = "{server}/AppSetting/{appKey}";
$headers = [
"Authorization: Bearer {your_access_token}"
];
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "get");
$response = curl_exec($ch);
curl_close($ch);
echo $response;
|
| using System;
using System.Net.Http;
using System.Threading.Tasks;
using System.Text;
using System.Text.Json;
class Program
{
static async Task Main()
{
using (var client = new HttpClient())
{
client.DefaultRequestHeaders.Add("Authorization", "Bearer {your_access_token}");
HttpResponseMessage response;
response = await client.getAsync("{server}/AppSetting/{appKey}");
var content = await response.Content.ReadAsStringAsync();
Console.WriteLine(content);
}
}
}
|
| require 'net/http'
require 'json'
uri = URI("{server}/AppSetting/{appKey}")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::undefined.new(uri)
request["Authorization"] = "Bearer {your_access_token}"
response = http.request(request)
puts response.body
|
| fetch("{server}/AppSetting/{appKey}", {
method: "get",
headers: {
"Authorization": "Bearer {your_access_token}"
}
})
.then(response => response.json())
.catch(error => console.error(error));
|
| import okhttp3.OkHttpClient;
import okhttp3.Request;
import okhttp3.Response;
import okhttp3.MediaType;
import okhttp3.RequestBody;
import org.json.JSONObject;
public class ApiClient {
private final OkHttpClient client = new OkHttpClient();
public void makeRequest() {
Request.Builder requestBuilder = new Request.Builder()
.url("{server}/AppSetting/{appKey}")
.addHeader("Authorization", "Bearer {your_access_token}");
requestBuilder.method("get", null);
try (Response response = client.newCall(requestBuilder.build()).execute()) {
System.out.println(response.body().string());
} catch (Exception e) {
e.printStackTrace();
}
}
}
|
| import Foundation
let url = URL(string: "{server}/AppSetting/{appKey}")!
var request = URLRequest(url: url)
request.httpMethod = "get"
request.setValue("Bearer {your_access_token}", forHTTPHeaderField: "Authorization")
request.setValue("application/json", forHTTPHeaderField: "Content-Type")
let task = URLSession.shared.dataTask(with: request) { data, response, error in
if let data = data {
if let json = try? JSONSerialization.jsonObject(with: data) {
print(json)
}
}
}
task.resume()
|
返回结果
| {
"code": 200 // 状态码,
"data": [
{
"id": "0" // 唯一标识,
"providerCode": "" // 提供商代码,
"groupCode": "" // 分组代码,
"code": "" // 设置项代码,
"value": "" // 设置值,
"tags": "" // 标签,
"description": "" // 描述,
"frontendUsable": false // 是否在前端可用,
"createDate": "" // 创建时间,
"lastUpdate": "" // 最后更新时间
}
] // 响应数据,
"error": "" // 错误信息
}
|
字段名 |
类型 |
描述 |
是否必填 |
code |
integer |
状态码 |
否 |
data |
array<AppSetting> |
响应数据 |
否 |
error |
string |
错误信息 |
否 |
增加配置
基本信息
- 接口名称:增加配置
- 请求方式:POST
- 请求路径:/AppSetting/{appKey}
请求参数
Path 参数
参数名 |
示例值 |
参数描述 |
是否必填 |
appKey |
- |
- |
是 |
Body 参数
参数名 |
类型 |
示例值 |
参数描述 |
是否必填 |
id |
integer |
- |
唯一标识 |
否 |
providerCode |
string |
- |
提供商代码 |
否 |
groupCode |
string |
- |
分组代码 |
否 |
code |
string |
- |
设置项代码 |
是 |
value |
string |
- |
设置值 |
是 |
tags |
string |
- |
标签 |
否 |
description |
string |
- |
描述 |
否 |
frontendUsable |
boolean |
- |
是否在前端可用 |
否 |
createDate |
string |
- |
创建时间 |
否 |
lastUpdate |
string |
- |
最后更新时间 |
否 |
示例代码
| import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.net.URI;
import com.fasterxml.jackson.databind.ObjectMapper;
import java.util.Map;
public class ApiClient {
public static void main(String[] args) {
HttpClient client = HttpClient.newHttpClient();
HttpRequest.Builder requestBuilder = HttpRequest.newBuilder()
.uri(URI.create("{server}/AppSetting/{appKey}"))
.header("Authorization", "Bearer {your_access_token}")
.header("Content-Type", "application/json");
// 创建请求体数据
Map<String, Object> data = {
"id": "0" // 唯一标识,
"providerCode": "" // 提供商代码,
"groupCode": "" // 分组代码,
"code": "" // 设置项代码,
"value": "" // 设置值,
"tags": "" // 标签,
"description": "" // 描述,
"frontendUsable": false // 是否在前端可用,
"createDate": "" // 创建时间,
"lastUpdate": "" // 最后更新时间
};
ObjectMapper mapper = new ObjectMapper();
String jsonBody = mapper.writeValueAsString(data);
RequestBody body = RequestBody.create(
MediaType.parse("application/json"), jsonBody);
requestBuilder.method("post", HttpRequest.BodyPublishers.ofString(jsonBody));
try {
HttpResponse<String> response = client.send(requestBuilder.build(), HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
} catch (Exception e) {
e.printStackTrace();
}
}
}
|
| import requests
url = "{server}/AppSetting/{appKey}"
headers = {
"Authorization": "Bearer {your_access_token}",
"Content-Type": "application/json"
}
data = {
"id": "0" // 唯一标识,
"providerCode": "" // 提供商代码,
"groupCode": "" // 分组代码,
"code": "" // 设置项代码,
"value": "" // 设置值,
"tags": "" // 标签,
"description": "" // 描述,
"frontendUsable": false // 是否在前端可用,
"createDate": "" // 创建时间,
"lastUpdate": "" // 最后更新时间
}
response = requests.post(
url,
headers=headers,
json=data
)
print(response.json())
|
| package main
import (
"fmt"
"io/ioutil"
"net/http"
"bytes"
"encoding/json"
)
func main() {
client := &http.Client{}
var req *http.Request
var err error
data := {
"id": "0" // 唯一标识,
"providerCode": "" // 提供商代码,
"groupCode": "" // 分组代码,
"code": "" // 设置项代码,
"value": "" // 设置值,
"tags": "" // 标签,
"description": "" // 描述,
"frontendUsable": false // 是否在前端可用,
"createDate": "" // 创建时间,
"lastUpdate": "" // 最后更新时间
}
jsonBody, err := json.Marshal(data)
if err != nil {
panic(err)
}
req, err = http.NewRequest("post", "{server}/AppSetting/{appKey}", bytes.NewBuffer(jsonBody))
if err != nil {
panic(err)
}
req.Header.Set("Content-Type", "application/json")
req.Header.Add("Authorization", "Bearer {your_access_token}")
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
body, err := ioutil.ReadAll(resp.Body)
if err != nil {
panic(err)
}
fmt.Println(string(body))
}
|
| const axios = require('axios');
const data = {
"id": "0" // 唯一标识,
"providerCode": "" // 提供商代码,
"groupCode": "" // 分组代码,
"code": "" // 设置项代码,
"value": "" // 设置值,
"tags": "" // 标签,
"description": "" // 描述,
"frontendUsable": false // 是否在前端可用,
"createDate": "" // 创建时间,
"lastUpdate": "" // 最后更新时间
};
const config = {
method: 'post',
url: '{server}/AppSetting/{appKey}',
headers: {
'Authorization': 'Bearer {your_access_token}',
'Content-Type': 'application/json'
},
data: data
};
axios(config)
.then(response => {
console.log(response.data);
})
.catch(error => {
console.error(error);
});
|
| <?php
$url = "{server}/AppSetting/{appKey}";
$headers = [
"Authorization: Bearer {your_access_token}",
"Content-Type: application/json"
];
$data = {
"id": "0" // 唯一标识,
"providerCode": "" // 提供商代码,
"groupCode": "" // 分组代码,
"code": "" // 设置项代码,
"value": "" // 设置值,
"tags": "" // 标签,
"description": "" // 描述,
"frontendUsable": false // 是否在前端可用,
"createDate": "" // 创建时间,
"lastUpdate": "" // 最后更新时间
};
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "post");
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
$response = curl_exec($ch);
curl_close($ch);
echo $response;
|
| using System;
using System.Net.Http;
using System.Threading.Tasks;
using System.Text;
using System.Text.Json;
class Program
{
static async Task Main()
{
using (var client = new HttpClient())
{
client.DefaultRequestHeaders.Add("Authorization", "Bearer {your_access_token}");
HttpResponseMessage response;
var data = {
"id": "0" // 唯一标识,
"providerCode": "" // 提供商代码,
"groupCode": "" // 分组代码,
"code": "" // 设置项代码,
"value": "" // 设置值,
"tags": "" // 标签,
"description": "" // 描述,
"frontendUsable": false // 是否在前端可用,
"createDate": "" // 创建时间,
"lastUpdate": "" // 最后更新时间
};
var content = new StringContent(
JsonSerializer.Serialize(data),
Encoding.UTF8,
"application/json");
response = await client.postAsync("{server}/AppSetting/{appKey}", content);
var content = await response.Content.ReadAsStringAsync();
Console.WriteLine(content);
}
}
}
|
| require 'net/http'
require 'json'
uri = URI("{server}/AppSetting/{appKey}")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::undefined.new(uri)
request["Authorization"] = "Bearer {your_access_token}"
request["Content-Type"] = "application/json"
data = {
"id": "0" // 唯一标识,
"providerCode": "" // 提供商代码,
"groupCode": "" // 分组代码,
"code": "" // 设置项代码,
"value": "" // 设置值,
"tags": "" // 标签,
"description": "" // 描述,
"frontendUsable": false // 是否在前端可用,
"createDate": "" // 创建时间,
"lastUpdate": "" // 最后更新时间
}
request.set_form_data(data)
response = http.request(request)
puts response.body
|
| const data = {
"id": "0" // 唯一标识,
"providerCode": "" // 提供商代码,
"groupCode": "" // 分组代码,
"code": "" // 设置项代码,
"value": "" // 设置值,
"tags": "" // 标签,
"description": "" // 描述,
"frontendUsable": false // 是否在前端可用,
"createDate": "" // 创建时间,
"lastUpdate": "" // 最后更新时间
};
fetch("{server}/AppSetting/{appKey}", {
method: "post",
headers: {
"Authorization": "Bearer {your_access_token}",
'Content-Type': 'application/json'
},
body: JSON.stringify(data)
})
.then(response => response.json())
.catch(error => console.error(error));
|
| import okhttp3.OkHttpClient;
import okhttp3.Request;
import okhttp3.Response;
import okhttp3.MediaType;
import okhttp3.RequestBody;
import org.json.JSONObject;
public class ApiClient {
private final OkHttpClient client = new OkHttpClient();
public void makeRequest() {
Request.Builder requestBuilder = new Request.Builder()
.url("{server}/AppSetting/{appKey}")
.addHeader("Authorization", "Bearer {your_access_token}")
.addHeader("Content-Type", "application/json");
JSONObject data = {
"id": "0" // 唯一标识,
"providerCode": "" // 提供商代码,
"groupCode": "" // 分组代码,
"code": "" // 设置项代码,
"value": "" // 设置值,
"tags": "" // 标签,
"description": "" // 描述,
"frontendUsable": false // 是否在前端可用,
"createDate": "" // 创建时间,
"lastUpdate": "" // 最后更新时间
};
RequestBody body = RequestBody.create(
MediaType.parse("application/json"), data.toString());
requestBuilder.method("post", body);
try (Response response = client.newCall(requestBuilder.build()).execute()) {
System.out.println(response.body().string());
} catch (Exception e) {
e.printStackTrace();
}
}
}
|
| import Foundation
let url = URL(string: "{server}/AppSetting/{appKey}")!
var request = URLRequest(url: url)
request.httpMethod = "post"
request.setValue("Bearer {your_access_token}", forHTTPHeaderField: "Authorization")
request.setValue("application/json", forHTTPHeaderField: "Content-Type")
let data = {
"id": "0" // 唯一标识,
"providerCode": "" // 提供商代码,
"groupCode": "" // 分组代码,
"code": "" // 设置项代码,
"value": "" // 设置值,
"tags": "" // 标签,
"description": "" // 描述,
"frontendUsable": false // 是否在前端可用,
"createDate": "" // 创建时间,
"lastUpdate": "" // 最后更新时间
}
let jsonData = try? JSONSerialization.data(withJSONObject: data)
request.httpBody = jsonData
let task = URLSession.shared.dataTask(with: request) { data, response, error in
if let data = data {
if let json = try? JSONSerialization.jsonObject(with: data) {
print(json)
}
}
}
task.resume()
|
返回结果
| {
"code": 200 // 状态码,
"data": {
"id": "0"
},
"error": "" // 错误信息
}
|
配置详情
基本信息
- 接口名称:配置详情
- 请求方式:GET
- 请求路径:/AppSetting/{appKey}/{id}
请求参数
Path 参数
参数名 |
示例值 |
参数描述 |
是否必填 |
id |
- |
配置ID |
是 |
appKey |
- |
- |
是 |
示例代码
| import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.net.URI;
import com.fasterxml.jackson.databind.ObjectMapper;
import java.util.Map;
public class ApiClient {
public static void main(String[] args) {
HttpClient client = HttpClient.newHttpClient();
HttpRequest.Builder requestBuilder = HttpRequest.newBuilder()
.uri(URI.create("{server}/AppSetting/{appKey}/{id}"))
.header("Authorization", "Bearer {your_access_token}");
requestBuilder.method("get", HttpRequest.BodyPublishers.noBody());
try {
HttpResponse<String> response = client.send(requestBuilder.build(), HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
} catch (Exception e) {
e.printStackTrace();
}
}
}
|
| import requests
url = "{server}/AppSetting/{appKey}/{id}"
headers = {
"Authorization": "Bearer {your_access_token}"
}
response = requests.get(
url,
headers=headers
)
print(response.json())
|
| package main
import (
"fmt"
"io/ioutil"
"net/http"
"bytes"
"encoding/json"
)
func main() {
client := &http.Client{}
var req *http.Request
var err error
req, err = http.NewRequest("get", "{server}/AppSetting/{appKey}/{id}", nil)
if err != nil {
panic(err)
}
req.Header.Add("Authorization", "Bearer {your_access_token}")
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
body, err := ioutil.ReadAll(resp.Body)
if err != nil {
panic(err)
}
fmt.Println(string(body))
}
|
| const axios = require('axios');
const config = {
method: 'get',
url: '{server}/AppSetting/{appKey}/{id}',
headers: {
'Authorization': 'Bearer {your_access_token}'
}
};
axios(config)
.then(response => {
console.log(response.data);
})
.catch(error => {
console.error(error);
});
|
| <?php
$url = "{server}/AppSetting/{appKey}/{id}";
$headers = [
"Authorization: Bearer {your_access_token}"
];
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "get");
$response = curl_exec($ch);
curl_close($ch);
echo $response;
|
| using System;
using System.Net.Http;
using System.Threading.Tasks;
using System.Text;
using System.Text.Json;
class Program
{
static async Task Main()
{
using (var client = new HttpClient())
{
client.DefaultRequestHeaders.Add("Authorization", "Bearer {your_access_token}");
HttpResponseMessage response;
response = await client.getAsync("{server}/AppSetting/{appKey}/{id}");
var content = await response.Content.ReadAsStringAsync();
Console.WriteLine(content);
}
}
}
|
| require 'net/http'
require 'json'
uri = URI("{server}/AppSetting/{appKey}/{id}")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::undefined.new(uri)
request["Authorization"] = "Bearer {your_access_token}"
response = http.request(request)
puts response.body
|
| fetch("{server}/AppSetting/{appKey}/{id}", {
method: "get",
headers: {
"Authorization": "Bearer {your_access_token}"
}
})
.then(response => response.json())
.catch(error => console.error(error));
|
| import okhttp3.OkHttpClient;
import okhttp3.Request;
import okhttp3.Response;
import okhttp3.MediaType;
import okhttp3.RequestBody;
import org.json.JSONObject;
public class ApiClient {
private final OkHttpClient client = new OkHttpClient();
public void makeRequest() {
Request.Builder requestBuilder = new Request.Builder()
.url("{server}/AppSetting/{appKey}/{id}")
.addHeader("Authorization", "Bearer {your_access_token}");
requestBuilder.method("get", null);
try (Response response = client.newCall(requestBuilder.build()).execute()) {
System.out.println(response.body().string());
} catch (Exception e) {
e.printStackTrace();
}
}
}
|
| import Foundation
let url = URL(string: "{server}/AppSetting/{appKey}/{id}")!
var request = URLRequest(url: url)
request.httpMethod = "get"
request.setValue("Bearer {your_access_token}", forHTTPHeaderField: "Authorization")
request.setValue("application/json", forHTTPHeaderField: "Content-Type")
let task = URLSession.shared.dataTask(with: request) { data, response, error in
if let data = data {
if let json = try? JSONSerialization.jsonObject(with: data) {
print(json)
}
}
}
task.resume()
|
返回结果
| {
"code": 200 // 状态码,
"data": {
"id": "0" // 唯一标识,
"providerCode": "" // 提供商代码,
"groupCode": "" // 分组代码,
"code": "" // 设置项代码,
"value": "" // 设置值,
"tags": "" // 标签,
"description": "" // 描述,
"frontendUsable": false // 是否在前端可用,
"createDate": "" // 创建时间,
"lastUpdate": "" // 最后更新时间
},
"error": "" // 错误信息
}
|
字段名 |
类型 |
描述 |
是否必填 |
code |
integer |
状态码 |
否 |
data |
AppSetting |
- |
否 |
error |
string |
错误信息 |
否 |
更新配置
基本信息
- 接口名称:更新配置
- 请求方式:PUT
- 请求路径:/AppSetting/{appKey}/{id}
请求参数
Path 参数
参数名 |
示例值 |
参数描述 |
是否必填 |
id |
- |
配置ID |
是 |
appKey |
- |
- |
是 |
Body 参数
参数名 |
类型 |
示例值 |
参数描述 |
是否必填 |
id |
integer |
- |
唯一标识 |
否 |
providerCode |
string |
- |
提供商代码 |
否 |
groupCode |
string |
- |
分组代码 |
否 |
code |
string |
- |
设置项代码 |
是 |
value |
string |
- |
设置值 |
是 |
tags |
string |
- |
标签 |
否 |
description |
string |
- |
描述 |
否 |
frontendUsable |
boolean |
- |
是否在前端可用 |
否 |
createDate |
string |
- |
创建时间 |
否 |
lastUpdate |
string |
- |
最后更新时间 |
否 |
示例代码
| import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.net.URI;
import com.fasterxml.jackson.databind.ObjectMapper;
import java.util.Map;
public class ApiClient {
public static void main(String[] args) {
HttpClient client = HttpClient.newHttpClient();
HttpRequest.Builder requestBuilder = HttpRequest.newBuilder()
.uri(URI.create("{server}/AppSetting/{appKey}/{id}"))
.header("Authorization", "Bearer {your_access_token}")
.header("Content-Type", "application/json");
// 创建请求体数据
Map<String, Object> data = {
"id": "0" // 唯一标识,
"providerCode": "" // 提供商代码,
"groupCode": "" // 分组代码,
"code": "" // 设置项代码,
"value": "" // 设置值,
"tags": "" // 标签,
"description": "" // 描述,
"frontendUsable": false // 是否在前端可用,
"createDate": "" // 创建时间,
"lastUpdate": "" // 最后更新时间
};
ObjectMapper mapper = new ObjectMapper();
String jsonBody = mapper.writeValueAsString(data);
RequestBody body = RequestBody.create(
MediaType.parse("application/json"), jsonBody);
requestBuilder.method("put", HttpRequest.BodyPublishers.ofString(jsonBody));
try {
HttpResponse<String> response = client.send(requestBuilder.build(), HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
} catch (Exception e) {
e.printStackTrace();
}
}
}
|
| import requests
url = "{server}/AppSetting/{appKey}/{id}"
headers = {
"Authorization": "Bearer {your_access_token}",
"Content-Type": "application/json"
}
data = {
"id": "0" // 唯一标识,
"providerCode": "" // 提供商代码,
"groupCode": "" // 分组代码,
"code": "" // 设置项代码,
"value": "" // 设置值,
"tags": "" // 标签,
"description": "" // 描述,
"frontendUsable": false // 是否在前端可用,
"createDate": "" // 创建时间,
"lastUpdate": "" // 最后更新时间
}
response = requests.put(
url,
headers=headers,
json=data
)
print(response.json())
|
| package main
import (
"fmt"
"io/ioutil"
"net/http"
"bytes"
"encoding/json"
)
func main() {
client := &http.Client{}
var req *http.Request
var err error
data := {
"id": "0" // 唯一标识,
"providerCode": "" // 提供商代码,
"groupCode": "" // 分组代码,
"code": "" // 设置项代码,
"value": "" // 设置值,
"tags": "" // 标签,
"description": "" // 描述,
"frontendUsable": false // 是否在前端可用,
"createDate": "" // 创建时间,
"lastUpdate": "" // 最后更新时间
}
jsonBody, err := json.Marshal(data)
if err != nil {
panic(err)
}
req, err = http.NewRequest("put", "{server}/AppSetting/{appKey}/{id}", bytes.NewBuffer(jsonBody))
if err != nil {
panic(err)
}
req.Header.Set("Content-Type", "application/json")
req.Header.Add("Authorization", "Bearer {your_access_token}")
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
body, err := ioutil.ReadAll(resp.Body)
if err != nil {
panic(err)
}
fmt.Println(string(body))
}
|
| const axios = require('axios');
const data = {
"id": "0" // 唯一标识,
"providerCode": "" // 提供商代码,
"groupCode": "" // 分组代码,
"code": "" // 设置项代码,
"value": "" // 设置值,
"tags": "" // 标签,
"description": "" // 描述,
"frontendUsable": false // 是否在前端可用,
"createDate": "" // 创建时间,
"lastUpdate": "" // 最后更新时间
};
const config = {
method: 'put',
url: '{server}/AppSetting/{appKey}/{id}',
headers: {
'Authorization': 'Bearer {your_access_token}',
'Content-Type': 'application/json'
},
data: data
};
axios(config)
.then(response => {
console.log(response.data);
})
.catch(error => {
console.error(error);
});
|
| <?php
$url = "{server}/AppSetting/{appKey}/{id}";
$headers = [
"Authorization: Bearer {your_access_token}",
"Content-Type: application/json"
];
$data = {
"id": "0" // 唯一标识,
"providerCode": "" // 提供商代码,
"groupCode": "" // 分组代码,
"code": "" // 设置项代码,
"value": "" // 设置值,
"tags": "" // 标签,
"description": "" // 描述,
"frontendUsable": false // 是否在前端可用,
"createDate": "" // 创建时间,
"lastUpdate": "" // 最后更新时间
};
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "put");
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
$response = curl_exec($ch);
curl_close($ch);
echo $response;
|
| using System;
using System.Net.Http;
using System.Threading.Tasks;
using System.Text;
using System.Text.Json;
class Program
{
static async Task Main()
{
using (var client = new HttpClient())
{
client.DefaultRequestHeaders.Add("Authorization", "Bearer {your_access_token}");
HttpResponseMessage response;
var data = {
"id": "0" // 唯一标识,
"providerCode": "" // 提供商代码,
"groupCode": "" // 分组代码,
"code": "" // 设置项代码,
"value": "" // 设置值,
"tags": "" // 标签,
"description": "" // 描述,
"frontendUsable": false // 是否在前端可用,
"createDate": "" // 创建时间,
"lastUpdate": "" // 最后更新时间
};
var content = new StringContent(
JsonSerializer.Serialize(data),
Encoding.UTF8,
"application/json");
response = await client.putAsync("{server}/AppSetting/{appKey}/{id}", content);
var content = await response.Content.ReadAsStringAsync();
Console.WriteLine(content);
}
}
}
|
| require 'net/http'
require 'json'
uri = URI("{server}/AppSetting/{appKey}/{id}")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::undefined.new(uri)
request["Authorization"] = "Bearer {your_access_token}"
request["Content-Type"] = "application/json"
data = {
"id": "0" // 唯一标识,
"providerCode": "" // 提供商代码,
"groupCode": "" // 分组代码,
"code": "" // 设置项代码,
"value": "" // 设置值,
"tags": "" // 标签,
"description": "" // 描述,
"frontendUsable": false // 是否在前端可用,
"createDate": "" // 创建时间,
"lastUpdate": "" // 最后更新时间
}
request.set_form_data(data)
response = http.request(request)
puts response.body
|
| const data = {
"id": "0" // 唯一标识,
"providerCode": "" // 提供商代码,
"groupCode": "" // 分组代码,
"code": "" // 设置项代码,
"value": "" // 设置值,
"tags": "" // 标签,
"description": "" // 描述,
"frontendUsable": false // 是否在前端可用,
"createDate": "" // 创建时间,
"lastUpdate": "" // 最后更新时间
};
fetch("{server}/AppSetting/{appKey}/{id}", {
method: "put",
headers: {
"Authorization": "Bearer {your_access_token}",
'Content-Type': 'application/json'
},
body: JSON.stringify(data)
})
.then(response => response.json())
.catch(error => console.error(error));
|
| import okhttp3.OkHttpClient;
import okhttp3.Request;
import okhttp3.Response;
import okhttp3.MediaType;
import okhttp3.RequestBody;
import org.json.JSONObject;
public class ApiClient {
private final OkHttpClient client = new OkHttpClient();
public void makeRequest() {
Request.Builder requestBuilder = new Request.Builder()
.url("{server}/AppSetting/{appKey}/{id}")
.addHeader("Authorization", "Bearer {your_access_token}")
.addHeader("Content-Type", "application/json");
JSONObject data = {
"id": "0" // 唯一标识,
"providerCode": "" // 提供商代码,
"groupCode": "" // 分组代码,
"code": "" // 设置项代码,
"value": "" // 设置值,
"tags": "" // 标签,
"description": "" // 描述,
"frontendUsable": false // 是否在前端可用,
"createDate": "" // 创建时间,
"lastUpdate": "" // 最后更新时间
};
RequestBody body = RequestBody.create(
MediaType.parse("application/json"), data.toString());
requestBuilder.method("put", body);
try (Response response = client.newCall(requestBuilder.build()).execute()) {
System.out.println(response.body().string());
} catch (Exception e) {
e.printStackTrace();
}
}
}
|
| import Foundation
let url = URL(string: "{server}/AppSetting/{appKey}/{id}")!
var request = URLRequest(url: url)
request.httpMethod = "put"
request.setValue("Bearer {your_access_token}", forHTTPHeaderField: "Authorization")
request.setValue("application/json", forHTTPHeaderField: "Content-Type")
let data = {
"id": "0" // 唯一标识,
"providerCode": "" // 提供商代码,
"groupCode": "" // 分组代码,
"code": "" // 设置项代码,
"value": "" // 设置值,
"tags": "" // 标签,
"description": "" // 描述,
"frontendUsable": false // 是否在前端可用,
"createDate": "" // 创建时间,
"lastUpdate": "" // 最后更新时间
}
let jsonData = try? JSONSerialization.data(withJSONObject: data)
request.httpBody = jsonData
let task = URLSession.shared.dataTask(with: request) { data, response, error in
if let data = data {
if let json = try? JSONSerialization.jsonObject(with: data) {
print(json)
}
}
}
task.resume()
|
返回结果
| {
"code": 200 // 状态码,
"data": false // 响应数据,
"error": "" // 错误信息
}
|
字段名 |
类型 |
描述 |
是否必填 |
code |
integer |
状态码 |
否 |
data |
boolean |
响应数据 |
否 |
error |
string |
错误信息 |
否 |
删除配置
基本信息
- 接口名称:删除配置
- 请求方式:DELETE
- 请求路径:/AppSetting/{appKey}/{id}
请求参数
Path 参数
参数名 |
示例值 |
参数描述 |
是否必填 |
id |
- |
配置ID |
是 |
appKey |
- |
- |
是 |
示例代码
| import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.net.URI;
import com.fasterxml.jackson.databind.ObjectMapper;
import java.util.Map;
public class ApiClient {
public static void main(String[] args) {
HttpClient client = HttpClient.newHttpClient();
HttpRequest.Builder requestBuilder = HttpRequest.newBuilder()
.uri(URI.create("{server}/AppSetting/{appKey}/{id}"))
.header("Authorization", "Bearer {your_access_token}");
requestBuilder.method("delete", HttpRequest.BodyPublishers.noBody());
try {
HttpResponse<String> response = client.send(requestBuilder.build(), HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
} catch (Exception e) {
e.printStackTrace();
}
}
}
|
| import requests
url = "{server}/AppSetting/{appKey}/{id}"
headers = {
"Authorization": "Bearer {your_access_token}"
}
response = requests.delete(
url,
headers=headers
)
print(response.json())
|
| package main
import (
"fmt"
"io/ioutil"
"net/http"
"bytes"
"encoding/json"
)
func main() {
client := &http.Client{}
var req *http.Request
var err error
req, err = http.NewRequest("delete", "{server}/AppSetting/{appKey}/{id}", nil)
if err != nil {
panic(err)
}
req.Header.Add("Authorization", "Bearer {your_access_token}")
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
body, err := ioutil.ReadAll(resp.Body)
if err != nil {
panic(err)
}
fmt.Println(string(body))
}
|
| const axios = require('axios');
const config = {
method: 'delete',
url: '{server}/AppSetting/{appKey}/{id}',
headers: {
'Authorization': 'Bearer {your_access_token}'
}
};
axios(config)
.then(response => {
console.log(response.data);
})
.catch(error => {
console.error(error);
});
|
| <?php
$url = "{server}/AppSetting/{appKey}/{id}";
$headers = [
"Authorization: Bearer {your_access_token}"
];
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "delete");
$response = curl_exec($ch);
curl_close($ch);
echo $response;
|
| using System;
using System.Net.Http;
using System.Threading.Tasks;
using System.Text;
using System.Text.Json;
class Program
{
static async Task Main()
{
using (var client = new HttpClient())
{
client.DefaultRequestHeaders.Add("Authorization", "Bearer {your_access_token}");
HttpResponseMessage response;
response = await client.deleteAsync("{server}/AppSetting/{appKey}/{id}");
var content = await response.Content.ReadAsStringAsync();
Console.WriteLine(content);
}
}
}
|
| require 'net/http'
require 'json'
uri = URI("{server}/AppSetting/{appKey}/{id}")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::undefined.new(uri)
request["Authorization"] = "Bearer {your_access_token}"
response = http.request(request)
puts response.body
|
| fetch("{server}/AppSetting/{appKey}/{id}", {
method: "delete",
headers: {
"Authorization": "Bearer {your_access_token}"
}
})
.then(response => response.json())
.catch(error => console.error(error));
|
| import okhttp3.OkHttpClient;
import okhttp3.Request;
import okhttp3.Response;
import okhttp3.MediaType;
import okhttp3.RequestBody;
import org.json.JSONObject;
public class ApiClient {
private final OkHttpClient client = new OkHttpClient();
public void makeRequest() {
Request.Builder requestBuilder = new Request.Builder()
.url("{server}/AppSetting/{appKey}/{id}")
.addHeader("Authorization", "Bearer {your_access_token}");
requestBuilder.method("delete", null);
try (Response response = client.newCall(requestBuilder.build()).execute()) {
System.out.println(response.body().string());
} catch (Exception e) {
e.printStackTrace();
}
}
}
|
| import Foundation
let url = URL(string: "{server}/AppSetting/{appKey}/{id}")!
var request = URLRequest(url: url)
request.httpMethod = "delete"
request.setValue("Bearer {your_access_token}", forHTTPHeaderField: "Authorization")
request.setValue("application/json", forHTTPHeaderField: "Content-Type")
let task = URLSession.shared.dataTask(with: request) { data, response, error in
if let data = data {
if let json = try? JSONSerialization.jsonObject(with: data) {
print(json)
}
}
}
task.resume()
|
返回结果
| {
"code": 200 // 状态码,
"data": false // 响应数据,
"error": "" // 错误信息
}
|
字段名 |
类型 |
描述 |
是否必填 |
code |
integer |
状态码 |
否 |
data |
boolean |
响应数据 |
否 |
error |
string |
错误信息 |
否 |
数据结构
AppSetting
| {
"id": "0" // 唯一标识,
"providerCode": "" // 提供商代码,
"groupCode": "" // 分组代码,
"code": "" // 设置项代码,
"value": "" // 设置值,
"tags": "" // 标签,
"description": "" // 描述,
"frontendUsable": false // 是否在前端可用,
"createDate": "" // 创建时间,
"lastUpdate": "" // 最后更新时间
}
|
字段名 |
类型 |
描述 |
是否必填 |
id |
integer |
唯一标识 |
否 |
providerCode |
string |
提供商代码 |
否 |
groupCode |
string |
分组代码 |
否 |
code |
string |
设置项代码 |
是 |
value |
string |
设置值 |
是 |
tags |
string |
标签 |
否 |
description |
string |
描述 |
否 |
frontendUsable |
boolean |
是否在前端可用 |
否 |
createDate |
string |
创建时间 |
否 |
lastUpdate |
string |
最后更新时间 |
否 |
AppSettingApiResponse
| {
"code": 200 // 状态码,
"data": {
"id": "0" // 唯一标识,
"providerCode": "" // 提供商代码,
"groupCode": "" // 分组代码,
"code": "" // 设置项代码,
"value": "" // 设置值,
"tags": "" // 标签,
"description": "" // 描述,
"frontendUsable": false // 是否在前端可用,
"createDate": "" // 创建时间,
"lastUpdate": "" // 最后更新时间
},
"error": "" // 错误信息
}
|
字段名 |
类型 |
描述 |
是否必填 |
code |
integer |
状态码 |
否 |
data |
- |
- |
否 |
error |
string |
错误信息 |
否 |
AppSettingGroupPostResult
字段名 |
类型 |
描述 |
是否必填 |
id |
integer |
- |
否 |
AppSettingGroupPostResultApiResponse
| {
"code": 200 // 状态码,
"data": {
"id": "0"
},
"error": "" // 错误信息
}
|
字段名 |
类型 |
描述 |
是否必填 |
code |
integer |
状态码 |
否 |
data |
- |
- |
否 |
error |
string |
错误信息 |
否 |
AppSettingItemPostResult
字段名 |
类型 |
描述 |
是否必填 |
id |
integer |
- |
否 |
AppSettingItemPostResultApiResponse
| {
"code": 200 // 状态码,
"data": {
"id": "0"
},
"error": "" // 错误信息
}
|
字段名 |
类型 |
描述 |
是否必填 |
code |
integer |
状态码 |
否 |
data |
- |
- |
否 |
error |
string |
错误信息 |
否 |
AppSettingListApiResponse
| {
"code": 200 // 状态码,
"data": [
{
"id": "0" // 唯一标识,
"providerCode": "" // 提供商代码,
"groupCode": "" // 分组代码,
"code": "" // 设置项代码,
"value": "" // 设置值,
"tags": "" // 标签,
"description": "" // 描述,
"frontendUsable": false // 是否在前端可用,
"createDate": "" // 创建时间,
"lastUpdate": "" // 最后更新时间
}
] // 响应数据,
"error": "" // 错误信息
}
|
字段名 |
类型 |
描述 |
是否必填 |
code |
integer |
状态码 |
否 |
data |
array |
响应数据 |
否 |
error |
string |
错误信息 |
否 |
AppSettingProviderPostResult
字段名 |
类型 |
描述 |
是否必填 |
id |
integer |
- |
否 |
AppSettingProviderPostResultApiResponse
| {
"code": 200 // 状态码,
"data": {
"id": "0"
},
"error": "" // 错误信息
}
|
字段名 |
类型 |
描述 |
是否必填 |
code |
integer |
状态码 |
否 |
data |
- |
- |
否 |
error |
string |
错误信息 |
否 |
AppSettingSettingPostResult
字段名 |
类型 |
描述 |
是否必填 |
id |
integer |
- |
否 |
AppSettingSettingPostResultApiResponse
| {
"code": 200 // 状态码,
"data": {
"id": "0"
},
"error": "" // 错误信息
}
|
字段名 |
类型 |
描述 |
是否必填 |
code |
integer |
状态码 |
否 |
data |
- |
- |
否 |
error |
string |
错误信息 |
否 |
BooleanApiResponse
| {
"code": 200 // 状态码,
"data": false // 响应数据,
"error": "" // 错误信息
}
|
字段名 |
类型 |
描述 |
是否必填 |
code |
integer |
状态码 |
否 |
data |
boolean |
响应数据 |
否 |
error |
string |
错误信息 |
否 |
ServiceGroup
| {
"id": "0" // 服务功能分组的唯一标识符。,
"providerID": "0" // 关联的服务商的唯一标识符。,
"name": "" // 服务功能分组的名称。,
"code": "" // 服务功能分组的唯一代码,用于系统内部标识。,
"icon": "" // 服务功能分组的图标URL或路径。,
"description": "" // 服务功能分组的详细描述信息。,
"show": false // 指示服务功能分组是否在界面上显示。,
"showIndex": "0" // 服务功能分组在界面上的显示顺序。,
"createDate": "" // 服务功能分组的创建日期,默认为当前时间。,
"lastUpdate": "" // 服务功能分组的最后更新日期,默认为当前时间。
}
|
字段名 |
类型 |
描述 |
是否必填 |
id |
integer |
服务功能分组的唯一标识符。 |
否 |
providerID |
integer |
关联的服务商的唯一标识符。 |
否 |
name |
string |
服务功能分组的名称。 |
否 |
code |
string |
服务功能分组的唯一代码,用于系统内部标识。 |
否 |
icon |
string |
服务功能分组的图标URL或路径。 |
否 |
description |
string |
服务功能分组的详细描述信息。 |
否 |
show |
boolean |
指示服务功能分组是否在界面上显示。 |
否 |
showIndex |
integer |
服务功能分组在界面上的显示顺序。 |
否 |
createDate |
string |
服务功能分组的创建日期,默认为当前时间。 |
否 |
lastUpdate |
string |
服务功能分组的最后更新日期,默认为当前时间。 |
否 |
ServiceGroupApiResponse
| {
"code": 200 // 状态码,
"data": {
"id": "0" // 服务功能分组的唯一标识符。,
"providerID": "0" // 关联的服务商的唯一标识符。,
"name": "" // 服务功能分组的名称。,
"code": "" // 服务功能分组的唯一代码,用于系统内部标识。,
"icon": "" // 服务功能分组的图标URL或路径。,
"description": "" // 服务功能分组的详细描述信息。,
"show": false // 指示服务功能分组是否在界面上显示。,
"showIndex": "0" // 服务功能分组在界面上的显示顺序。,
"createDate": "" // 服务功能分组的创建日期,默认为当前时间。,
"lastUpdate": "" // 服务功能分组的最后更新日期,默认为当前时间。
},
"error": "" // 错误信息
}
|
字段名 |
类型 |
描述 |
是否必填 |
code |
integer |
状态码 |
否 |
data |
- |
- |
否 |
error |
string |
错误信息 |
否 |
ServiceGroupListApiResponse
| {
"code": 200 // 状态码,
"data": [
{
"id": "0" // 服务功能分组的唯一标识符。,
"providerID": "0" // 关联的服务商的唯一标识符。,
"name": "" // 服务功能分组的名称。,
"code": "" // 服务功能分组的唯一代码,用于系统内部标识。,
"icon": "" // 服务功能分组的图标URL或路径。,
"description": "" // 服务功能分组的详细描述信息。,
"show": false // 指示服务功能分组是否在界面上显示。,
"showIndex": "0" // 服务功能分组在界面上的显示顺序。,
"createDate": "" // 服务功能分组的创建日期,默认为当前时间。,
"lastUpdate": "" // 服务功能分组的最后更新日期,默认为当前时间。
}
] // 响应数据,
"error": "" // 错误信息
}
|
字段名 |
类型 |
描述 |
是否必填 |
code |
integer |
状态码 |
否 |
data |
array |
响应数据 |
否 |
error |
string |
错误信息 |
否 |
ServiceItem
| {
"id": "0" // 服务配置项的唯一标识符。,
"bizCode": "" // 服务配置项所属的业务代码,用于分类管理。,
"providerCode": "" // 关联的服务商代码,用于标识提供该配置项的服务商。,
"groupCode": "" // 服务配置项所属的功能分组代码,用于组织和管理相关配置项。,
"name": "" // 服务配置项的名称,用于描述其功能或用途。,
"code": "" // 服务配置项的唯一代码,用于系统内部标识。,
"valueType": "" // 服务配置项的值类型,例如 'text', 'number', 'boolean' 等。默认为 'text'。,
"icon": "" // 服务配置项的图标URL或路径,用于在界面上显示。,
"valueDefaults": "" // 服务配置项的默认值,当未设置具体值时使用。,
"description": "" // 服务配置项的详细描述信息,用于说明其用途和配置方法。,
"tags": "" // 用于分类或标记服务配置项的标签。,
"isSystem": false // 指示该配置项是否为系统级别的配置项,默认为 false。,
"show": false // 指示服务配置项是否在界面上显示,默认为 true。,
"showIndex": "0" // 服务配置项在界面上的显示顺序。,
"createDate": "" // 服务配置项的创建日期,默认为当前时间。,
"lastUpdate": "" // 服务配置项的最后更新日期,默认为当前时间。
}
|
字段名 |
类型 |
描述 |
是否必填 |
id |
integer |
服务配置项的唯一标识符。 |
否 |
bizCode |
string |
服务配置项所属的业务代码,用于分类管理。 |
否 |
providerCode |
string |
关联的服务商代码,用于标识提供该配置项的服务商。 |
否 |
groupCode |
string |
服务配置项所属的功能分组代码,用于组织和管理相关配置项。 |
否 |
name |
string |
服务配置项的名称,用于描述其功能或用途。 |
否 |
code |
string |
服务配置项的唯一代码,用于系统内部标识。 |
否 |
valueType |
string |
服务配置项的值类型,例如 'text', 'number', 'boolean' 等。默认为 'text'。 |
否 |
icon |
string |
服务配置项的图标URL或路径,用于在界面上显示。 |
否 |
valueDefaults |
string |
服务配置项的默认值,当未设置具体值时使用。 |
否 |
description |
string |
服务配置项的详细描述信息,用于说明其用途和配置方法。 |
否 |
tags |
string |
用于分类或标记服务配置项的标签。 |
否 |
isSystem |
boolean |
指示该配置项是否为系统级别的配置项,默认为 false。 |
否 |
show |
boolean |
指示服务配置项是否在界面上显示,默认为 true。 |
否 |
showIndex |
integer |
服务配置项在界面上的显示顺序。 |
否 |
createDate |
string |
服务配置项的创建日期,默认为当前时间。 |
否 |
lastUpdate |
string |
服务配置项的最后更新日期,默认为当前时间。 |
否 |
ServiceItemApiResponse
| {
"code": 200 // 状态码,
"data": {
"id": "0" // 服务配置项的唯一标识符。,
"bizCode": "" // 服务配置项所属的业务代码,用于分类管理。,
"providerCode": "" // 关联的服务商代码,用于标识提供该配置项的服务商。,
"groupCode": "" // 服务配置项所属的功能分组代码,用于组织和管理相关配置项。,
"name": "" // 服务配置项的名称,用于描述其功能或用途。,
"code": "" // 服务配置项的唯一代码,用于系统内部标识。,
"valueType": "" // 服务配置项的值类型,例如 'text', 'number', 'boolean' 等。默认为 'text'。,
"icon": "" // 服务配置项的图标URL或路径,用于在界面上显示。,
"valueDefaults": "" // 服务配置项的默认值,当未设置具体值时使用。,
"description": "" // 服务配置项的详细描述信息,用于说明其用途和配置方法。,
"tags": "" // 用于分类或标记服务配置项的标签。,
"isSystem": false // 指示该配置项是否为系统级别的配置项,默认为 false。,
"show": false // 指示服务配置项是否在界面上显示,默认为 true。,
"showIndex": "0" // 服务配置项在界面上的显示顺序。,
"createDate": "" // 服务配置项的创建日期,默认为当前时间。,
"lastUpdate": "" // 服务配置项的最后更新日期,默认为当前时间。
},
"error": "" // 错误信息
}
|
字段名 |
类型 |
描述 |
是否必填 |
code |
integer |
状态码 |
否 |
data |
- |
- |
否 |
error |
string |
错误信息 |
否 |
ServiceItemListApiResponse
| {
"code": 200 // 状态码,
"data": [
{
"id": "0" // 服务配置项的唯一标识符。,
"bizCode": "" // 服务配置项所属的业务代码,用于分类管理。,
"providerCode": "" // 关联的服务商代码,用于标识提供该配置项的服务商。,
"groupCode": "" // 服务配置项所属的功能分组代码,用于组织和管理相关配置项。,
"name": "" // 服务配置项的名称,用于描述其功能或用途。,
"code": "" // 服务配置项的唯一代码,用于系统内部标识。,
"valueType": "" // 服务配置项的值类型,例如 'text', 'number', 'boolean' 等。默认为 'text'。,
"icon": "" // 服务配置项的图标URL或路径,用于在界面上显示。,
"valueDefaults": "" // 服务配置项的默认值,当未设置具体值时使用。,
"description": "" // 服务配置项的详细描述信息,用于说明其用途和配置方法。,
"tags": "" // 用于分类或标记服务配置项的标签。,
"isSystem": false // 指示该配置项是否为系统级别的配置项,默认为 false。,
"show": false // 指示服务配置项是否在界面上显示,默认为 true。,
"showIndex": "0" // 服务配置项在界面上的显示顺序。,
"createDate": "" // 服务配置项的创建日期,默认为当前时间。,
"lastUpdate": "" // 服务配置项的最后更新日期,默认为当前时间。
}
] // 响应数据,
"error": "" // 错误信息
}
|
字段名 |
类型 |
描述 |
是否必填 |
code |
integer |
状态码 |
否 |
data |
array |
响应数据 |
否 |
error |
string |
错误信息 |
否 |
ServiceProvider
| {
"id": "0" // 服务商的唯一标识符。,
"bizCode": "" // 服务商的业务代码,用于标识其所属业务领域。,
"name": "" // 服务商的名称。,
"code": "" // 服务商的唯一代码,用于系统内部标识。,
"icon": "" // 服务商图标的URL或路径。,
"description": "" // 服务商的详细描述信息。,
"tags": "" // 用于分类或标记服务商的标签。,
"show": false // 指示服务商是否在界面上显示。,
"showIndex": "0" // 服务商在界面上的显示顺序。,
"createDate": "" // 服务商记录的创建日期,默认为当前时间。,
"lastUpdate": "" // 服务商记录的最后更新日期,默认为当前时间。
}
|
字段名 |
类型 |
描述 |
是否必填 |
id |
integer |
服务商的唯一标识符。 |
否 |
bizCode |
string |
服务商的业务代码,用于标识其所属业务领域。 |
否 |
name |
string |
服务商的名称。 |
否 |
code |
string |
服务商的唯一代码,用于系统内部标识。 |
否 |
icon |
string |
服务商图标的URL或路径。 |
否 |
description |
string |
服务商的详细描述信息。 |
否 |
tags |
string |
用于分类或标记服务商的标签。 |
否 |
show |
boolean |
指示服务商是否在界面上显示。 |
否 |
showIndex |
integer |
服务商在界面上的显示顺序。 |
否 |
createDate |
string |
服务商记录的创建日期,默认为当前时间。 |
否 |
lastUpdate |
string |
服务商记录的最后更新日期,默认为当前时间。 |
否 |
ServiceProviderApiResponse
| {
"code": 200 // 状态码,
"data": {
"id": "0" // 服务商的唯一标识符。,
"bizCode": "" // 服务商的业务代码,用于标识其所属业务领域。,
"name": "" // 服务商的名称。,
"code": "" // 服务商的唯一代码,用于系统内部标识。,
"icon": "" // 服务商图标的URL或路径。,
"description": "" // 服务商的详细描述信息。,
"tags": "" // 用于分类或标记服务商的标签。,
"show": false // 指示服务商是否在界面上显示。,
"showIndex": "0" // 服务商在界面上的显示顺序。,
"createDate": "" // 服务商记录的创建日期,默认为当前时间。,
"lastUpdate": "" // 服务商记录的最后更新日期,默认为当前时间。
},
"error": "" // 错误信息
}
|
字段名 |
类型 |
描述 |
是否必填 |
code |
integer |
状态码 |
否 |
data |
- |
- |
否 |
error |
string |
错误信息 |
否 |
ServiceProviderListApiResponse
| {
"code": 200 // 状态码,
"data": [
{
"id": "0" // 服务商的唯一标识符。,
"bizCode": "" // 服务商的业务代码,用于标识其所属业务领域。,
"name": "" // 服务商的名称。,
"code": "" // 服务商的唯一代码,用于系统内部标识。,
"icon": "" // 服务商图标的URL或路径。,
"description": "" // 服务商的详细描述信息。,
"tags": "" // 用于分类或标记服务商的标签。,
"show": false // 指示服务商是否在界面上显示。,
"showIndex": "0" // 服务商在界面上的显示顺序。,
"createDate": "" // 服务商记录的创建日期,默认为当前时间。,
"lastUpdate": "" // 服务商记录的最后更新日期,默认为当前时间。
}
] // 响应数据,
"error": "" // 错误信息
}
|
字段名 |
类型 |
描述 |
是否必填 |
code |
integer |
状态码 |
否 |
data |
array |
响应数据 |
否 |
error |
string |
错误信息 |
否 |
通用错误码