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

ユーザー:Login

提供ベンダー:
システム名:
MAFFアプリ
利用条件:
WAGRI会員は無償

概要

API名称
ユーザー
説明

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

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

データの更新頻度
随時
カテゴリー
添付ファイル

関連メソッド

リクエスト

URL

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

説明

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

HTTPメソッド
POST
パラメータ
Header
名称 値の説明
Content-Type application/json string 必須
X-Authorization WAGRI アクセストークン string 必須
WAGRI のアクセストークン
Body
名称 値の説明
mail メールアドレス string MAFF事務局へ申請した登録メールアドレス
password パスワード string MAFF事務局から発行されたパスワード

 

呼出例
URL

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

Header

X-Authorization:{WAGRI API アクセストークン}

Content-Type: application/json

Body
{
  "mail": "MAFF事務局へ申請した登録メールアドレス",
  "password": "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 サーバー内部でエラーが発生しました。

サンプルソースコード

ソースコード

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)

 

前に戻る
上部へスクロール