Documentドキュメント
Authorize認証
Authorize URL に必要パラメータを加えてリクエストを行うことで認証画面が表示されます。
GET https://api.shinobi.jp/oauth
パラメータ
項目 | 説明 |
---|---|
response_type | code を指定してください。 |
client_id | アプリケーションの識別 ID。 |
redirect_uri | 認証した後に遷移するアプリケーションの URL。 |
scope | サービスで指定されている値を指定します。カンマ区切りで複数指定できます。 |
state | 任意の値を指定できます。 |
認証した場合、code パラメータに認可コードを付与してリダイレクト URI に遷移します。
Access tokenアクセストークン
Access token URL に認可コードと必要なパラメータを加えて POST リクエストを行うことでアクセストークンを取得できます
POST https://api.shinobi.jp/oauth/token
パラメータ
項目 | 説明 |
---|---|
grant_type | authorization_code を指定してください。 |
client_id | アプリケーションの識別 ID。 |
client_secret | アプリケーションの秘密鍵。 |
redirect_uri | 認証した後に遷移するアプリケーションの URL。 |
code | 認証処理で取得した認可コード。 |
アクセストークンのレスポンスは次のような JSON 形式になります。
Status: 200 OK
{
"access_token":"exMCPLgZw8gzPByekqZk58D0q6WlgShXYcWmlshJ",
"token_type":"Bearer",
"expires":1412328194,
"expires_in":"36000",
"refresh_token":"TCJctX2PlEOxYkNkqgbcowcHNSVaeWOS9YdqCTeH"
}
項目 | 説明 |
---|---|
access_token | API の利用に用いるアクセストークン。 |
toke_type | アクセストークンの種類。 |
expires | アクセストークンが失効する時間。 |
expires_in | アクセストークンが失効するまでの秒数。 |
refresh_token | アクセストークンの更新する時に利用するリフレッシュトークン。(ない場合もあります) |
APIAPI
API はアクセストークンを access_token パラメータか Authorization ヘッダに指定してリクエストします。
-
パラメータに指定する場合
GET https://api.shinobi.jp/v1/user?access_token=exMCPLgZw8gzPByekqZk58D0q6WlgShXYcWmlshJ
-
Authorization ヘッダに指定する場合
GET /v1/user HTTP/1.1 Host: api.shinobi.jp Authorization: Bearer exMCPLgZw8gzPByekqZk58D0q6WlgShXYcWmlshJ
ベース URI
https://api.shinobi.jp