client

Agora REST Client for Go

agora-rest-client-go是用Go语言编写的一个开源项目，专门为 Agora REST API设计。它包含了 Agora 官方提供的REST API接口的包装和内部实现，可以帮助开发者更加方便的集成服务端Agora REST API。

特性

• 封装了Agora REST API的请求和响应处理，简化与Agora REST API 的通信流程
• 当遇到 DNS 解析失败、网络错误或者请求超时等问题的时候，提供了自动切换最佳域名的能力，以保障请求 REST API 服务的可用性
• 提供了易于使用的API，可轻松地实现调用 Agora REST API 的常见功能，如开启云录制、停止云录制等
• 基于Go语言，具有高效性、并发性和可扩展性

支持的服务

• 云端录制 Cloud Recording

环境准备

• Go 1.18 或以上版本
• 在声网 Console 平台申请的 App ID 和 App Certificate
• 在声网 Console 平台的 Basic Auth 认证信息
• 在声网 Console 平台开启相关的服务能力

安装

使用以下命令从 GitHub 安装依赖：

go get -u github.com/AgoraIO-Community/agora-rest-client-go

使用示例

以调用云录制服务为例：

package main

import (
	"context"
	"log"

	"github.com/AgoraIO-Community/agora-rest-client-go/core"
	"github.com/AgoraIO-Community/agora-rest-client-go/services/cloudrecording"
	v1 "github.com/AgoraIO-Community/agora-rest-client-go/services/cloudrecording/v1"
)

const (
	appId    = "<your appId>"
	username = "<the username of basic auth credential>"
	password = "<the password of basic auth credential>"
	cname    = "<your cname>"
	uid      = "<your uid>"
)

func main() {
	// 初始化Agora REST API客户端
	client := core.NewClient(&core.Config{
		AppID:      appId,
		Credential: core.NewBasicAuthCredential(username, password),
		// 指定服务器所在的区域，可选值有CN, NA, EU, AP,client 将会根据配置的区域自动切换使用最佳的域名
		RegionCode: core.CN,
        // 指定日志输出的级别，可选值有LogDebug, LogInfo, LogWarn, LogError
        // 如果要关闭日志输出，可将 logger 设置为 DiscardLogger
		Logger:     core.NewDefaultLogger(core.LogDebug),
	}) 
    // 初始化云端录制服务 API
	cloudRecordingAPI := cloudrecording.NewAPI(client)

    // 调用云端录制服务 API 的Acquire接口
	resp, err := cloudRecordingAPI.V1().Acquire().Do(context.TODO(), &v1.AcquirerReqBody{
		Cname: cname,
		Uid:   uid,
		ClientRequest: &v1.AcquirerClientRequest{
			Scene:               0,
			ResourceExpiredHour: 24,
		},
	})
    // 处理非业务错误
	if err != nil {
		log.Fatal(err)
	}
	if resp.IsSuccess() {
		// 处理业务上成功响应
		log.Printf("resourceId:%s", resp.SuccessRes.ResourceId)
	} else {
        // 处理业务上失败响应
		log.Printf("resp:%+v", resp)
	}
}

更多的示例可在Example 查看

集成遇到困难，该如何联系声网获取协助

方案1：如果您已经在使用声网服务或者在对接中，可以直接联系对接的销售或服务

方案2：发送邮件给 support@agora.io 咨询

方案3：扫码加入我们的微信交流群提问

贡献

本项目欢迎并接受贡献。如果您在使用中遇到问题或有改进建议，请提出issue或向我们提交Pull Request。

SemVer 版本规范

本项目使用语义化版本号规范 (SemVer) 来管理版本。格式为 MAJOR.MINOR.PATCH。

• MAJOR 版本号表示不向后兼容的重大更改。
• MINOR 版本号表示向后兼容的新功能或增强。
• PATCH 版本号表示向后兼容的错误修复和维护。 有关详细信息，请参阅 语义化版本 规范。

参考

• Agora API 文档

许可证

该项目使用MIT许可证，详细信息请参阅LICENSE文件。