#api-client #client-token #client-id #client-secret #generated #data #opinionated

tripactions

为TripActions API提供的完全生成且具有意见的API客户端

9个不稳定版本 (4个破坏性版本)

0.7.0 2023年7月19日
0.7.0-rc.12023年6月12日
0.4.0 2023年3月31日
0.3.1 2022年11月18日
0.1.1 2021年7月8日

#2249 in Web编程

MIT 许可证

92KB
2K SLoC

tripactions

为TripActions提供的完全生成、具有意见的API客户端库。

docs.rs

API详细信息

欢迎使用TripActions预订数据API参考文档。

您可以使用此API从TripActions检索预订数据。

要访问API,您的公司管理员需要向您提供客户端ID和密钥。他们可以在TripActions管理仪表板中生成这些信息,在设置页面的集成部分。


要生成令牌,请使用您的凭据向令牌API发出请求

curl --request POST --url 'https://api.tripactions.com/ta-auth/oauth/token' \
--header 'content-type:application/x-www-form-urlencoded' \
--data grant_type=client_credentials \
--data client_id=YOURCLIENTIDHERE \
--data client_secret=YOURSECRETHERE

生成令牌后,您可以调用预订数据API

curl --请求GET --urlhttps://api.tripactions.com/v1/bookings\?createdFrom\=1609459200\&createdTo\=1623229202\&page\=0\&size\=10 --header 'Authorization:Bearer YOURTOKENHERE'

客户端详细信息

此客户端基于API规范版本 1TripActions OpenAPI规范生成。这样,随着功能的添加,它将保持最新。库的文档与代码一起生成,以便使此库易于使用。

要安装库,请将以下内容添加到您的 Cargo.toml 文件中。

[dependencies]
tripactions = "0.7.0"

基本示例

典型用法需要初始化一个 Client。这需要一个用户代理字符串和一组凭据。

use tripactions::Client;

let tripactions = Client::new(
    String::from("client-id"),
    String::from("client-secret"),
    String::from("token"),
);

或者,库可以在环境中搜索客户端所需的大部分变量

  • TRIPACTIONS_CLIENT_ID
  • TRIPACTIONS_CLIENT_SECRET

然后您可以从环境中创建一个客户端。

use tripactions::Client;

let tripactions = Client::new_from_env(
    String::from("token"),
);

对于 token,传递空值是可以的。在客户端的初始状态下,您将不知道此值。

要启动一个新的客户端并获取一个 令牌,请使用以下方法。

use tripactions::Client;

async fn do_call() {
    let mut tripactions = Client::new_from_env("");

    let mut access_token = tripactions.get_access_token().await.unwrap();
}

依赖项

~16–31MB
~602K SLoC