- API (データ&プログラム) -API(data&program)

Token:アクセストークン取得API

提供ベンダー:
システム名:
WAGRI運営事務局
利用条件:
WAGRI会員は無償

概要

API名称
Token
説明

APIにアクセストークンを発行する。

データの更新頻度
該当なし
カテゴリー
添付ファイル

関連メソッド

リクエスト

URL

https://api.wagri.net/Token

説明

APIにアクセスするトークンを発行する。

WAGRI会員登録後に取得するクライアントID およびクライアントシークレットが必要です。

HTTPメソッド
POST
パラメータ

リクエストデータ定義

  • Header

Content-Type:application/x-www-form-urlencoded

  • Body
名称 値の説明
grant_type client_credentials string 固定値
client_id クライアントID string WAGRI会員登録後に取得するクライアントID※1
client_secret クライアントシークレット string ※1に対するクライアントシークレット

 

呼出例

POST  https://api.wagri.net /Token

Header

Content-Type = application/x-www-form-urlencoded

Body

grant_type = client_credentials
client_id = {クライアント ID}
client_secret = { クライアントシークレット}

レスポンス

レイアウト

レスポンスデータ定義

名称 値の説明
access_token API呼び出しに使用するアクセストークン string
token_type トークンタイプ string
expires_in トークンの有効期限(単位は秒) integer

 

レスポンス例

アクセストークンの発行が成功した場合、以下様な応答が返却されます。

※access_token の値’*********’には、実際に発行されたトークンの文字列が表示されます。

{
'access_token': '********', 
'token_type': 'bearer', 
'expires_in': 43199
}

 

ステータスコード
コード 名称 値の説明
200 Created リクエストが成功しました。
400 Bad Request リクエストが不正です。
401 Unauthorized 認証情報が不正です。
403 Forbidden リソースのアクセスが禁止されています。
500 Internal Server Error サーバー内部でエラーが発生しました。

 

サンプルソースコード

ソースコード

Python(requestsモジュール)でのサンプルコード

ステータスコードと結果を表示するサンプルコードです。

import requests

url = 'https://api.wagri.net/Token'

headers = {
           'Content-Type': 'application/x-www-form-urlencoded'
          }
payload = {
           "grant_type":"client_credentials",
           "client_id":"クライアントID",
           "client_secret":"クライアントシークレット"
          }

res = requests.post(url,headers=headers,data=payload)

print(res.text)

応答結果サンプル

※access_token の値’*********’には、実際に発行されたトークンの文字列が表示されます。

{'access_token': '********', 'token_type': 'bearer', 'expires_in': 43199}
前に戻る
上部へスクロール
Scroll to Top