Skip to content

README.md

Latest commit

 

History

History
53 lines (31 loc) · 1.46 KB

README.md

File metadata and controls

53 lines (31 loc) · 1.46 KB

yxt-api Gem Version

An unofficial 云学堂 http://www.yxt.com/ API wrap gem.

Official document

https://open.yunxuetang.cn/#/document?&id=1641790366267643906

Installation

Add this line to your application's Gemfile:

gem 'yxt-api'

And then execute:

$ bundle

Or install it yourself as:

$ gem install yxt-api

Usage

Config

Create config/initializers/yxt-api.rb and put following configurations into your Rails project.

Yxt.app_id          = 'your_app_id'
Yxt.app_secret      = 'your_app_secret'
Yxt.api_origin_url  = 'https://openapi.yunxuetang.cn' # notice no / at end
Yxt.token_origin_url = 'https://openapi.yunxuetang.cn' # optional, default same as api_origin_url
Yxt.token_cache_file = '/tmp/yxt-access-token-your_app_id.json' # optional

Yxt.request will automatically fetch accessToken from /token, cache it in a local temp file, and refresh it when expired.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/thape-cn/yxt-api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.