ユーザー：Login

公開日 2021-02-05

更新日 2024-11-19

提供ベンダー

農林水産省（MAFFアプリ）

システム名

MAFFアプリ

利用条件

無償オプションAPI（申込必要）

概要

API名称

ユーザー

説明

アクセストークンの認証に指定するアクセストークンを取得する。

ご利用にはMAFF事務局への利用申請が必要です。

添付ファイル

ー

データの更新頻度

随時

リクエスト

URL

ー

説明

ユーザログイン処理を行い、アクセストークンを取得する。
ご利用にはMAFF事務局への利用申請が必要です。
詳細は、MAFF事務局への利用申請後に提供されるAPI利用マニュアルを参照下さい。

HTTPメソッド

POST

パラメータ

Header

名称	値	型	値の説明
Content-Type	application/json	string	必須
X-Authorization	WAGRI アクセストークン	string	必須 WAGRI のアクセストークン

Body

名称	値	型	値の説明
mail	メールアドレス	string	MAFF事務局へ申請した登録メールアドレス
password	パスワード	string	MAFF事務局から発行されたパスワード

呼出例

ー

レスポンス

レイアウト

詳細はMAFF事務局への利用申請後に提供されるAPI利用マニュアルを参照下さい。

レスポンスデータ定義

名称	値	型	値の説明
loginhash	アクセストークンに用いる値※	string	アクセストークンに用いる値が返却される

※MAFF APIのアクセストークン認証では、上記のloginhashで返却される値の先頭に、xxx (x3つと半角スペース)を付与した文字列をAuthorizationに指定します。これがMAFF APIのアクセストークンとなります。

レスポンス例

{
  "result": 1,
  "user": {
    "user_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "mail": "********@****.****.co.jp",
    "gender": 2,
    "birthyear": 1982,
    "prefecture": 13,
    "city": 13103,
    "cityName": "港区",
    "class": 1,
    "management": 2,
    "career": 10,
    "main_work": [],
    "scale": 1000,
    "other_works": [],
    "interest_categories": [],
    "isPush": true,
    "isShowedProfileFlag": true
  },
  "loginhash": "***************************************",
  "refresh_token": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}

ステータスコード

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

サンプルソースコード

プログラム記述例（WAGRI共通）

import requests
url = "https://api.wagri.net/API/Public/AgriculturalLand/SearchByCityCode"
payload = {
'CityCode': '432041'
}
headers = {
'X-Authorization': 'アクセストークン',
}
response = requests.get(url, headers=headers, params=payload)
print(response.text)

プログラム記述例（個別API）

Python（requestsモジュール）での例

import requests
import json

url = "https://api.wagri.net/API/Individual/MAFFAPP/Users/Login"

payload = json.dumps({
  "mail": "MAFF事務局へ申請した登録メールアドレス",
  "password": "MAFF事務局から発行されたパスワード"
})
headers = {
  'X-Authorization': 'WAGRIアクセストークン',
  'Content-Type': 'application/json',
}

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

print(response.text)