yhsd-api-ruby

友好速搭应用开发 Ruby SDK

安装

在应用的gem file 中添加:

  gem 'yhsd_api'

执行:

  $ bundle

或者直接使用命令行进行安装:

  $ gem install yhsd_api

使用方法

###1，私有应用

配置私有应用的app_key, app_secret

  YhsdApi.configure do |config|
    config.app_key = '配置你的app_key'
    config.app_secret = '配置你的app_secret'
    config.token_url = 'https://apps.youhaosuda.com/oauth2/token/'
    config.api_url = 'https://api.youhaosuda.com/'
    config.api_version = 'v1/'
  end

获取友好速搭token

  YhsdApi::PrivateApp.generate_token

调用友好速搭api接口

  #get 接口调用
  #url 需要访问的api接口的地址
  #返回结果
  #code :200
  #body hash 数据
  #header hash 数据
  YhsdApi::PrivateApp.get(url)

  #put 接口调用
  #url 需要访问的api接口的地址
  #params 参数
  #返回结果
  #code :200
  #body hash 数据
  #header hash 数据
  YhsdApi::PrivateApp.put(url, params)

  #post 接口调用
  #url 需要访问的api接口的地址
  #params 参数
  #返回结果
  #code :200
  #body hash 数据
  #header hash 数据
  YhsdApi::PrivateApp.post(url, params)

  #delete 接口调用
  #url 需要访问的api接口的地址
  #返回结果
  #code :200
  #body hash 数据
  #header hash 数据
  YhsdApi::PrivateApp.delete(url)

例子

  YhsdApi::PrivateApp.token = '获取到的token'

  #get 接口调用
  code, body, header = YhsdApi::PrivateApp.get("shop")

  #put 接口调用
  params = {
    "redirect": {
      "path": "/12345",
      "target": "/blogs"
    }
  }
  code, body, header = YhsdApi::PrivateApp.put("redirects/1", params)

  #post 接口调用
  params = {
    "redirect": {
      "path": "/12345",
      "target": "/blogs"
    }
  }
  code, body, header = YhsdApi::PrivateApp.put("redirects", params)

  #delete 接口调用
  code, body, header = YhsdApi::PrivateApp.delete("redirects/1")

友好速搭的token是不过期的，你也可以通过

  YhsdApi::PrivateApp.token = '你的私有应用token'

来进行指定token值，这样就不需要调用generate_token来获取token值了。

###2，开放应用

配置公有一用的app_key, app_secret

  YhsdApi.configure do |config|
    config.app_key = '配置你的app_key'
    config.app_secret = '配置你的app_secret'
    config.scope = '配置你的应用scope'
    config.auth_url = "https://apps.youhaosuda.com/oauth2/authorize/"
    config.token_url = 'https://apps.youhaosuda.com/oauth2/token/'
    config.api_url = 'https://api.youhaosuda.com/'
    config.api_version = 'v1/'
  end

友好速搭hmac验证，获取到参数后调用

  #true 表示验证正确 false 表示错误
  #params 为获取到的所有参数
  YhsdApi::PublicApp.verify_hmac(params)

友好速搭授权回调url获取

  #返回结果 友好速搭授权url
  #redirect_url应用的跳转地址
  #shop_key 友好速搭安装应用的店铺唯一key
  #state 自定义的参数
  YhsdApi::PublicApp.authorize_url(redirect_url, shop_key, state)

友好速搭店铺token获取

  #返回结果 店铺的开放应用token
  #redirect_url 应用的跳转地址
  #code友好速搭返回获取授权码的code
  YhsdApi::PublicApp::generate_token(redirect_url, code)

调用友好速搭api接口

  #get 接口调用
  #token 访问token
  #url 需要访问的api接口的地址
  #返回结果
  #code :200
  #body hash 数据
  #header hash 数据
  YhsdApi::PublicApp.get(token, url)

  #put 接口调用
  #token 访问token
  #url 需要访问的api接口的地址
  #params 参数
  #返回结果
  #code :200
  #body hash 数据
  #header hash 数据
  YhsdApi::PublicApp.put(token, url, params)

  #post 接口调用
  #token 访问token
  #url 需要访问的api接口的地址
  #params 参数
  #返回结果
  #code :200
  #body hash 数据
  #header hash 数据
  YhsdApi::PublicApp.post(token, url, params)

  #delete 接口调用
  #token 访问token
  #url 需要访问的api接口的地址
  #返回结果
  #code :200
  #body hash 数据
  #header hash 数据
  YhsdApi::PublicApp.delete(token, url)

例子

  token = '店铺的访问token'

  #get 接口调用
  code, body, header = YhsdApi::PublicApp.get(token, "shop")

  #put 接口调用
  params = {
    "redirect": {
      "path": "/12345",
      "target": "/blogs"
    }
  }
  code, body, header = YhsdApi::PublicApp.put(token, "redirects/1", params)

  #post 接口调用
  params = {
    "redirect": {
      "path": "/12345",
      "target": "/blogs"
    }
  }
  code, body, header = YhsdApi::PublicApp.put("token, "redirects", params)

  #delete 接口调用
  code, body, header = YhsdApi::PublicApp.delete(token, "redirects/1")

贡献

Fork it ( https://github.com/yeezon/yhsd-api-ruby/fork )
Create your feature branch (git checkout -b my-new-feature)
Commit your changes (git commit -am 'Add some feature')
Push to the branch (git push origin my-new-feature)
Create a new Pull Request

yhsd_api

Development

Runtime

yhsd-api-ruby

安装

使用方法

贡献