持有API key等参数缺失baseURL时如何用Python或C#请求API数据

整体实现前置说明 #

必须先获取对应接口的baseURL，这是API服务的根访问地址，没有该参数无法构造完整的请求地址，你可以找对应API的提供方文档或者对接人获取，同时还要确认要调用的接口路径、请求方法（GET/POST等）、参数传递规则。

通用实现逻辑 #

• 拼接完整请求地址：完整地址 = baseURL + 接口路径
• 配置API key的传递规则：绝大多数场景下API key会放在请求头的Authorization字段，值格式为Bearer 你的API key，少数场景会放在请求参数中，以接口文档要求为准
• 把testuserid、testChargingid按接口要求放到对应的请求参数位置（GET请求的query参数、POST请求的body参数）
• 发起网络请求，校验响应状态，解析返回数据

Python实现示例 #

需要先安装第三方网络请求库requests，安装命令：pip install requests

import requests

# 替换为你实际的参数值
BASE_URL = "替换为获取到的baseURL"
API_KEY = "你的API key"
TEST_USER_ID = "你的testuserid"
TEST_CHARGING_ID = "你的testChargingid"
API_PATH = "替换为实际要调用的接口路径"

def request_api_data():
    full_url = f"{BASE_URL}{API_PATH}"
    # 构造请求头
    headers = {
        "Authorization": f"Bearer {API_KEY}",
        "Content-Type": "application/json"
    }
    # 构造请求参数，此处为GET请求query参数示例，POST请求可将参数放到json字段中
    params = {
        "userid": TEST_USER_ID,
        "chargingid": TEST_CHARGING_ID
    }
    try:
        # 发起GET请求，POST请求替换为requests.post()即可
        resp = requests.get(full_url, headers=headers, params=params)
        # 校验请求是否成功（状态码为200系列）
        resp.raise_for_status()
        # 解析返回的JSON格式数据
        result = resp.json()
        print("请求成功，返回数据：", result)
        return result
    except Exception as e:
        print("请求出错：", str(e))
        return None

if __name__ == "__main__":
    request_api_data()

C#实现示例 #

基于.NET自带的HttpClient实现，无需额外安装依赖包

using System;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;

class ApiTest
{
    // 替换为你实际的参数值
    private const string BaseUrl = "替换为获取到的baseURL";
    private const string ApiKey = "你的API key";
    private const string TestUserId = "你的testuserid";
    private const string TestChargingId = "你的testChargingid";
    private const string ApiPath = "替换为实际要调用的接口路径";

    static async Task Main(string[] args)
    {
        using var httpClient = new HttpClient();
        httpClient.BaseAddress = new Uri(BaseUrl);
        // 配置请求头
        httpClient.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", ApiKey);
        httpClient.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json"));

        try
        {
            // 构造GET请求地址，拼接query参数
            var requestUrl = $"{ApiPath}?userid={TestUserId}&chargingid={TestChargingId}";
            var resp = await httpClient.GetAsync(requestUrl);
            // 校验请求是否成功
            resp.EnsureSuccessStatusCode();
            // 读取返回的JSON字符串
            var result = await resp.Content.ReadAsStringAsync();
            Console.WriteLine($"请求成功，返回数据：{result}");
        }
        catch (Exception e)
        {
            Console.WriteLine($"请求出错：{e.Message}");
        }
    }
}

注意事项 #

• 以上示例均为GET请求场景，如接口要求POST传参，Python可调整为requests.post(full_url, headers=headers, json=参数对象)，C#可调整为httpClient.PostAsync(requestUrl, new StringContent(Json序列化后的参数字符串, Encoding.UTF8, "application/json"))
• 生产环境不要把API key硬编码在代码中，建议存放到环境变量或者独立配置文件中，避免密钥泄露
• 可根据业务需要对返回的JSON数据做进一步的解析和业务处理

内容的提问来源于stack exchange，提问作者new_bie_new