Sync API接入指南

授权

Basic Authorization (推荐服务器端程序使用)

使用 Basic Authorization 来进行鉴权 (推荐服务器端程序使用). 步骤如下:

在 UOS 网站上获取当前需要使用的 UOS APP 的 AppId 和 AppServiceSecret
注：此处 AppId 和 AppServiceSecret，可在 UOS 网站上获取
在请求任意 API 的 Request Header 中增加 Header:
- Authorization: Basic base64(appId:appServiceSecret)

示例代码

# C# 使用示例 - Basic 授权方式
using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Security.Cryptography;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

class Program
{
    private static string GetBasicAuthorization(string appId, string appServiceSecret)
    {
        string credentials = $"{appId}:{appServiceSecret}";
        byte[] credentialsBytes = Encoding.UTF8.GetBytes(credentials);
        string encodedCredentials = Convert.ToBase64String(credentialsBytes);
        return $"Basic {encodedCredentials}";
    }

    public static async Task Main(string[] args)
    {
        using (HttpClient client = new HttpClient())
        {
            // 使用项目的 APP_ID, APP_SERVICE_SECRET 获取 headers
            client.DefaultRequestHeaders.Add("Authorization", GetBasicAuthorization(APP_ID, APP_SERVICE_SECRET));

            // 以get方法为例，替换 url 为你需要请求的 url
            HttpResponseMessage response = await client.GetAsync(url);
            response.EnsureSuccessStatusCode();

           // 其他处理……
        }
    }
}

Python

# Python 使用示例 - Basic 授权方式
import base64
import requests

def get_basic_authorization(app_id, app_service_secret):
  """ 获取basic auth的Header """
  credentials = f'{app_id}:{app_service_secret}'
  encoded_credentials = base64.b64encode(credentials.encode("utf-8")).decode("utf-8")
  return {'Authorization': f'Basic {encoded_credentials}'}

# 使用 APP_ID, APP_SERVICE_SECRET 获取Basic Token Header
headers = get_basic_authorization(APP_ID, APP_SERVICE_SECRET)
# 以get方法为例，替换 url 为你需要请求的 url
response = requests.get(url, headers=headers)

JavaScript

// JavaScript 使用示例 - Basic 授权方式
const axios = require('axios');

function getBasicAuthorization(appId, appServiceSecret) {
  /** 获取 basic auth 的 Header */
  const credentials = `${appId}:${appServiceSecret}`;
  const encodedCredentials = btoa(credentials);
  return { 'Authorization': `Basic ${encodedCredentials}` };
}

// 使用 APP_ID, APP_SERVICE_SECRET 获取Basic Token Header
const headers = getBasicAuthorization(APP_ID, APP_SERVICE_SECRET);
// 以get方法为例，替换 url 为你需要请求的 url
const response = await axios.get(url, { headers });

// Go 使用示例 - Basic 授权方式
import (
    "bytes"
    "encoding/base64"
    "encoding/json"
    "fmt"
    "io"
    "net/http"
)

func GetBasicAuthorization(appID, appServiceSecret string) string {
    credentials := appID + ":" + appServiceSecret
    encodedCredentials := base64.StdEncoding.EncodeToString([]byte(credentials))
    return "Basic " + encodedCredentials
}


func main() {
    // 以get方法为例，替换 url 为你需要请求的 url
    req, err := http.NewRequest("GET", url, nil)
    if err != nil {
        return nil, err
    }

    // 使用 APP_ID, APP_SERVICE_SECRET 获取Basic Token Header
    req.Header.Set("Authorization", GetBasicAuthorization(APP_ID, APP_SERVICE_SECRET))

    client := &http.Client{}
    response, err := client.Do(req)
    if err != nil {
        return nil, err
    }
    defer resp.Body.Close()
    // ……其他处理
}

Nonce Authorization (推荐客户端程序使用)

使用 Nonce Authorization 来进行鉴权 (推荐客户端程序使用)。步骤如下:

在 UOS 网站上获取当前需要使用的 UOS APP 的 AppId 和 AppSecret
注：此处 AppId 和 AppSecret，可在 UOS 网站上获取
在请求任意 Sync API 的 Request Header 中增加如下 Header:
- X-TIMESTAMP: 当前时间戳
- X-NONCE: 随机生成的UUID
- X-APPID: 当前需要使用的 UOS APP 的 AppId
- Authorization: nonce hexadecimal(sha256(appId + ":" + appSecret + ":" + X-TIMESTAMP + ":" + X-NONCE))

示例代码:

# C# 使用示例 - Nonce 授权方式
using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Security.Cryptography;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

class Program
{
  private static Dictionary<string, string GetNonceAuthorization(string appId, string appSecret)
  {
    string nonce = Guid.NewGuid().ToString();
    long timestamp = DateTimeOffset.UtcNow.ToUnixTimeSeconds();

    string signString = $"{appId}:{appSecret}:{timestamp}:{nonce}";
    byte[] signBytes = Encoding.UTF8.GetBytes(signString);

    using (SHA256 sha256 = SHA256.Create())
    {
      byte[] hashBytes = sha256.ComputeHash(signBytes);
      string token = BitConverter.ToString(hashBytes).Replace("-", "").ToLower();

      return new Dictionary<string, string
      {
        { "X-APPID", appId },
        { "X-TIMESTAMP", timestamp.ToString() },
        { "X-NONCE", nonce },
        { "Authorization", $"nonce {token}" }
      };
    }
  }

  public static async Task Main(string[] args)
  {
    using (HttpClient client = new HttpClient())
    {
      // 使用项目的 APP_ID, APP_SECRET 获取 headers
      var headers = GetNonceAuthorization(APP_ID, APP_SECRET);
      foreach (var header in headers)
      {
        client.DefaultRequestHeaders.Add(header.Key, header.Value);
      }

      // 以get方法为例，替换 url 为你需要请求的 url
      HttpResponseMessage response = await client.GetAsync(url);

      // 其他处理……
    }
  }
}

Python

# Python 使用示例 - Nonce 授权方式
import hashlib
import time
import uuid
import binascii
import requests

def get_nonce_authorization(app_id, app_secret):
  """生成 nonce 授权 Headers"""
  nonce = str(uuid.uuid4())
  timestamp = int(time.time())
  calculated_check_sum = hashlib.sha256(f'{app_id}:{app_secret}:{timestamp}:{nonce}'.encode()).digest()
  token = binascii.hexlify(calculated_check_sum).decode()
  headers = {
    'X-APPID': app_id,
    'X-TIMESTAMP': str(timestamp),
    'X-NONCE': nonce,
    'Authorization': f'nonce {token}',
    'Content-Type': 'application/json'
  }
  return headers

# 使用项目的 APP_ID, APP_SECRET 获取 headers
headers = get_nonce_authorization(APP_ID, APP_SECRET)
# 替换 url 为你需要请求的 url
response = requests.get(url, headers=headers)

JavaScript

// JavaScript - Nonce 授权方式
const axios = require('axios');

function getNonceAuthorization(appId, appSecret) {
const nonce = crypto.randomUUID();
const timestamp = Math.floor(Date.now() / 1000);

    const signString = `${appId}:${appSecret}:${timestamp}:${nonce}`;
    const hash = crypto.createHash('sha256').update(signString).digest('hex');

    return {
        'X-APPID': appId,
        'X-TIMESTAMP': timestamp.toString(),
        'X-NONCE': nonce,
        'Authorization': `nonce ${hash}`
    };
}

// 使用 APP_ID, APP_SECRET 获取Nonce Token Header
const headers = getNonceAuthorization(APP_ID, APP_SECRET);
// 以get方法为例，替换 url 为你需要请求的 url
const response = await axios.get(url, { headers });

Sync API列表

API Endpoint: https://s.unity.cn