利用可能なログインプロバイダの取得
指定された Web API キーに紐付いた「サービス」で、設定が完了し、利用可能なログインプロバイダの一覧を取得します。
GET /api/providers
リクエスト
Path パラメーター
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| key | string | ○ | Web API キー |
リクエストサンプル
curl -X GET https://api.socialplus.jp/api/providers \
-d key={Web API キー}
エラーレスポンス
関連: 共通エラー定義
エラーコード
| HTTP ステータスコード | Code | Message | 説明 |
|---|---|---|---|
| 401(Unauthorized) | 1 | Invalid API key or key not found. | API キーが指定されていないか、存在しないAPIキーです |
成功レスポンス
リクエストに成功すると、HTTP ステータスコード 200 OK と、JSON オブジェクトを返します。
成功時のレスポンス例
HTTP/1.1 200 OK
Content-Type: application/json
{
"status": "ok",
"providers": [
"line",
"yahoo",
"google"
]
}
レスポンスパラメーター
| パラメータ名 | 型 | 最大長 | 説明 |
|---|---|---|---|
| status | string | 15 | リクエストが成功したかどうか(ok または failed) |
| providers | array of string | 255 | 利用可能なログインプロバイダ |