freee-api 0.0.5 → 0.0.6
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile.lock +1 -1
- data/README.md +71 -0
- data/lib/freee/api/version.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA1:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 1ae67ab1488860af099560de6b032e38cb3add3b
|
|
4
|
+
data.tar.gz: ab38179237d3098ae758642c2b18a5750a38180e
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: a2e7e5c44527d9af35f8c7ddb30c362daef3c54a730c5ea248140f6bd10a888c8c388d7bc6aeb4c55d49aca5b008765849daa44ba28fa7bbab227739fb9ae3fd
|
|
7
|
+
data.tar.gz: 28b2d238ea4b27b5f023945a4ca3a9e2f3dfd4384e36561b03f83ccb090bb2528df255fd79a3ed333483a00a1a6d4de82b074c598b68800515fd2d547e7fc165
|
data/Gemfile.lock
CHANGED
data/README.md
CHANGED
|
@@ -30,8 +30,79 @@ freee APIを利用するためには、事前に利用するアプリケーシ
|
|
|
30
30
|
アプリケーションを登録することで表示されるアプリケーションIDとSecretが必要になります。
|
|
31
31
|
|
|
32
32
|
詳しくは以下をご覧ください。
|
|
33
|
+
|
|
33
34
|
[https://support.freee.co.jp/hc/ja/articles/115000145263-freee-API%E3%81%AE%E3%82%A2%E3%82%AF%E3%82%BB%E3%82%B9%E3%83%88%E3%83%BC%E3%82%AF%E3%83%B3%E3%82%92%E5%8F%96%E5%BE%97%E3%81%99%E3%82%8B#1](https://support.freee.co.jp/hc/ja/articles/115000145263-freee-API%E3%81%AE%E3%82%A2%E3%82%AF%E3%82%BB%E3%82%B9%E3%83%88%E3%83%BC%E3%82%AF%E3%83%B3%E3%82%92%E5%8F%96%E5%BE%97%E3%81%99%E3%82%8B#1)
|
|
34
35
|
|
|
36
|
+
### アクセストークンの取得(初回)
|
|
37
|
+
|
|
38
|
+
各リクエストを行うために、アクセストークンの取得が必要となります。
|
|
39
|
+
上記の、アプリケーションの登録後取得したアプリケーションIDとSecretを設定したOAuth2クライアントのオブジェクトを生成します。
|
|
40
|
+
その後、認証コードを取得するために、POSTリクエストのレスポンスを返すコールバック用URLを設定します。
|
|
41
|
+
|
|
42
|
+
```ruby
|
|
43
|
+
|
|
44
|
+
oauth2 = Freee::Api::Token.new(application_id, secret)
|
|
45
|
+
oauth2.authorize('localhost')
|
|
46
|
+
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
なお、本番環境では、POSTリエクスト用のコールバック用URLの指定が必要となりますが、開発環境・テスト環境の場合はブラウザアクセスでも認証コードが取得できます。
|
|
50
|
+
その際は、
|
|
51
|
+
|
|
52
|
+
`https://secure.freee.co.jp/oauth/authorize?client_id={application_id}&redirect_uri=urn%3Aietf%3Awg%3Aoauth%3A2.0%3Aoob&response_type=code`
|
|
53
|
+
|
|
54
|
+
でブラウザアクセスを行います。`application_id` は登録したアプリケーションのIDを指定してください。
|
|
55
|
+
|
|
56
|
+
|
|
57
|
+
|
|
58
|
+
取得した認証コードでアクセストークンを取得します。認証コードの有効期限は10分です。
|
|
59
|
+
|
|
60
|
+
```ruby
|
|
61
|
+
response = oauth2.get_access_token('auth_code', 'localhost')
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
成功すると、レスポンスとして下記のようなアクセストークン、リフレッシュトークンが得られるため、この結果をDBに保存したりキャッシュで保持すれば、後はアクセストークン経由で各リクエストが実行できます。
|
|
65
|
+
|
|
66
|
+
```ruby
|
|
67
|
+
{
|
|
68
|
+
"access_token": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
|
|
69
|
+
"token_type": "bearer",
|
|
70
|
+
"expires_in": 86400,
|
|
71
|
+
"refresh_token": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
|
|
72
|
+
"scope": "read write"
|
|
73
|
+
}
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
## このGemでできること
|
|
77
|
+
|
|
78
|
+
このGemでは、Freeeの会計APIのリクエストを行えるようになります。
|
|
79
|
+
各リクエストの概要・詳細は以下をご覧ください。
|
|
80
|
+
|
|
81
|
+
[会計API概要](https://developer.freee.co.jp/docs/accounting)
|
|
82
|
+
|
|
83
|
+
[会計APIリファレンス](https://developer.freee.co.jp/docs/accounting/reference)
|
|
84
|
+
|
|
85
|
+
|
|
86
|
+
また、現在このGemのバージョンで対応しているリクエストは以下のドキュメントを参考にしてください。
|
|
87
|
+
|
|
88
|
+
[https://www.rubydoc.info/gems/freee-api](https://www.rubydoc.info/gems/freee-api)
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
不足しているリクエストの実装、ドキュメント生成に関しましては今しばらくお待ちください。
|
|
92
|
+
issueに残していただければ、優先して対応します。
|
|
93
|
+
|
|
94
|
+
### アクセストークンの取得(2回目以降)
|
|
95
|
+
|
|
96
|
+
有効期限が切れたアクセストークンではリクエストを実行できないため、リフレッシュトークンを利用して新しいアクセストークンを取得します。
|
|
97
|
+
|
|
98
|
+
```ruby
|
|
99
|
+
oauth2 = Freee::Api::Token.new(application_id, secret)
|
|
100
|
+
response = oauth2.refresh_token(access_token, refresh_token, expires_at)
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
アクセストークンの有効期限は24時間、リフレッシュトークンの有効期限は無制限です。
|
|
104
|
+
|
|
105
|
+
|
|
35
106
|
## Development
|
|
36
107
|
|
|
37
108
|
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
|
data/lib/freee/api/version.rb
CHANGED
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: freee-api
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.0.
|
|
4
|
+
version: 0.0.6
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- himrock922
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: exe
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2018-08-
|
|
11
|
+
date: 2018-08-25 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: bundler
|