本篇介绍一下用友 U8 API接口如何快速上手。(用友U8开放平台地址 open.yonyouup.com/)

流程:

  1. 注册成为开发者(用于创建用友U8 API应用);
  2. 注册企业账号(用于提供数据);
  3. U8服务器上配置用友服务器数据接口,并安装和运行“用友开放平台客户端”;
  4. 开发者账号创建应用,并向企业账号申请授权;
  5. 企业账号审批通过应用授权申请,并在网站后台为应用配置数据源;
  6. 开发接入。

一、开发者和企业账号

首先,开发应用需要注册一个用友开放平台的开发者账号,通过认证后,可以在管理页面创建自己的应用,填写应用的基本信息,并选择需要的接口权限后,应用就创建完成了。

然后,用户需要到授权页面向指定的企业账号发起调用申请,在这个页面里也可以看到授权状态、U8开放平台客户端的运行状态。

而作为数据源的所有者,企业也需要注册一个开放平台的账号(企业账号应该也可以直接认证成开发者),这个账号主要有三个任务:审批来自开发者的应用授权申请;为开发者的应用配置数据源(网站和服务器);通过U8服务器上的开放平台软件发布数据接口。

下图是企业账号审批、查看应用授权的界面:

企业账号在审批应用申请后,还需要为应用配置数据参数,一个应用参数包含U8参数,数据库参数,具体如下:

二、服务器数据源配置

服务器上一共用到三个软件:
1. EAI接口设置:身份验证和数据源配置
2. EAI环境检测与修复工具(平时没什么用,用来检测运行环境)3. 用友开放平台客户端(数据代理程序,必须打开才能提供外部数据访问)

三、接入

  • 开发者:创建应用、申请权限;
  • 企业账号:审批应用、配置网页数据参数、配置服务器EAI数据源、运行开放平台客户端。

完成上述工作后,就可以正式接入API并开始开发工作了。

需要注意的是,应用程序只需要具备Internet访问能力即可,不需要直接访问U8服务器,所有数据请求会从U8开放平台代理到U8服务器上。

用友开放平台API参考手册:https://u8open.yonyou.com/apiCenter/index

在开始前,第一步要做的就是用创建应用时的appkey和appsecret拿到Token,有了Token就可以按业务需求进行数据交互了。

除了token参数,几乎所有接口都有一个from_account参数和to_account参数,就像字面上所说,前者from_account指开发者账号,后者to_account是指数据提供方的企业账号。

Response


/// <summary>
/// 非列表类型的数据接口Response
/// </summary>
public class U8ResponseBase
{
    [JsonPropertyName("errcode")]
    public string ErrorCode { get; set; } = string.Empty;

    [JsonPropertyName("errmsg")]
    public string ErrorMessage { get; set; } = string.Empty;

    public bool Succ => ErrorCode == "0";
}
/// <summary>
/// 列表类型的数据接口Response
/// </summary>
public class U8ResponseList : U8ResponseBase
{
    [JsonPropertyName("page_index")]
    public string PageIndex { get; set; } = "0";

    [JsonPropertyName("page_count")]
    public string PageCount { get; set; } = "0";

    [JsonPropertyName("row_count")]
    public string RowCount { get; set; } = "0";
}

Token

public class U8ResponseToken : U8ResponseBase
{
    [JsonPropertyName("token")]
    public U8Token? Token { get; set; }
}
public class U8Token
{
    [JsonPropertyName("appKey")]
    public string AppKey { get; set; } = "";
    [JsonPropertyName("expiresIn")]
    public int ExpiresIn { get; set; }
    [JsonPropertyName("id")]
    public string Id { get; set; } = "";
    /// <summary>
    /// Token过期时间,取真实有效期的90%
    /// </summary>
    public DateTime Exp { get; set; }
}

GetToken(非列表类型的数据接口)

/// <summary>
/// 获取U8 Api Token
/// </summary>
/// <param name="source">调用方,仅用于记录</param>
/// <param name="force">不判断当前Token有效性,强制重新请求一个Token</param>
/// <returns></returns>
public static void GetToken(bool force = false)
{
    //有效期剩余>10%,并且未要求强制刷新,并且上一次获取Token成功
    if (Token.Exp < DateTime.Now && !force && Token.Success)
    {
        Console.WriteLine("GetToken: Skip");
        return;
    }
    using WebClient client = new();

    Token.Success = false;
    try
    {
        string resp = client.DownloadString($"https://api.yonyouup.com/system/token?" +
            $"from_account={STRINGS.FROM_ACCOUNT}&app_key={U8Credentials[0].AppKey}&app_secret={U8Credentials[0].AppSecret}");
        var respObj = JsonSerializer.Deserialize<U8ResponseToken>(resp);
        if (respObj?.Token is null)
        {
            Console.WriteLine("GetToken: FAILED");
            return;
        }

        Token = respObj.Token;
        Token.Success = true;
        Token.Exp = DateTime.Now.AddSeconds(Token.ExpiresIn * 0.9);
        Console.WriteLine(JsonSerializer.Serialize(Token));
    }
    catch (Exception ex)
    {
        Console.WriteLine($"GetToken: Exception {ex.Message}");
    }//失败了就等下一次
}

批量获取采购订单(列表类型的数据接口)


public static void GetPurchaseOrders(DateTime start, DateTime end)
{
    if (start.Year < 2000) start = DateTime.Now.AddDays(-7);
    if (end.Year < 2000) end = DateTime.Now;
    if (start > end) (start, end) = (end, start);

    string date_begin = start.ToString("yyyy-MM-dd");
    string date_end = end.ToString("yyyy-MM-dd");
    //https://api.yonyouup.com/api/purchaseorderlist/batch_get
    using WebClient client = new();
    int pagecount = 1;
    int page = 1;
    List<U8PurchaseOrderSimple> simples = new();
    while (page == 1 || page <= pagecount)
    {
        string resp = client.DownloadString($"https://api.yonyouup.com/api/purchaseorderlist/batch_get?from_account={STRINGS.FROM_ACCOUNT}&to_account={STRINGS.TO_ACCOUNT}&" +
        $"app_key={U8Credentials[0].AppKey}&token={Token.Id}&rows_per_page=100&page_index={page++}&date_begin={date_begin}&date_end={date_end}");
        var batch = JsonSerializer.Deserialize<U8ResponsePurchaseOrderList>(resp) ?? new();
        simples = simples.Concat(batch.Orders).ToList();
        pagecount = Convert.ToInt32(batch.PageCount);
        Console.WriteLine($"{batch.PageIndex} of {pagecount}, {simples.Count} of {batch.RowCount}\r\n{resp}");
    }
}

public class U8ResponsePurchaseOrderList : U8ResponseList
{
    [JsonPropertyName("purchaseorderlist")]
    public List<U8PurchaseOrderSimple> Orders { get; set; } = new();
}
分类: articles