ケイコとナマブ.net 通信講座 Webサービスを使うことで、ケイコとマナブ.net 通信講座に掲載されている、通信講座情報にアクセスして、アプリケーションを構築することができます。
![[4]](../common/images/ref-num4.gif)
エラー時のレスポンス![[5]](../common/images/ref-num5.gif)
Flashからの利用方法
講座検索API
ケイコとマナブ.net、通信講座に掲載中の講座・レッスン情報から複数の軸での検索が可能です。
リクエストURL
検索クエリ
| パラメータ | 項目名 | 説明 | 必須 | 値 |
|---|---|---|---|---|
| key | APIキー | APIを利用するために割り当てられたキーを設定します。 | ○ | |
| code | 講座CD | 講座毎のコード。複数指定可能*2 | *1 | (例) 0001790612 |
| school | スクールCD | スクール毎のコード。複数指定可能*2 | *1 | (例) S000000 |
| category | カテゴリコード | カテゴリマスタAPI参照。複数指定可能*2 | *1 | (例) G010005 |
| capsule | カプセルコード | カプセルマスタAPI参照。複数指定可能*2 | *1 | (例) G020015 |
| price | 費用 | 費用をコードで指定できます。複数指定可能*2 複数指定の場合でも0が含まれると、指定なしになります。 |
*1 | 0:指定なし(デフォルト)、1:〜1万円未満、2:1万〜3万円未満、3:3万〜5万円未満、4:5万～10万円未満、5:10万～30万円未満、6:30万～50万円未満、7:50万円〜 |
| kyufu | 給付制度有無フラグ | 給付制度が利用できる講座で絞り込めます。 | *1 | 0:絞り込まない。(デフォルト) 、1:利用できる講座のみ |
| tensaku | 添削コード | 添削の有無と方式で絞りこめます。複数指定可能*2 複数指定の場合でも0が含まれると、指定なしになります。 |
*1 | 0:指定なし。(デフォルト) 、1: 通信講座（添削あり）、2: 教材送付のみ(添削なし)、3: eラーニング |
| mobile | 携帯ページ有無フラグ | 携帯ページの有無で絞り込めます。 | *1 | 0:絞り込まない。(デフォルト) 、1:携帯ページありのみ |
| keyword | フリーワード | 文字コードはUTF8。半角スペース区切りの文字列を渡すことでAND検索になる。複数指定可能*2。 別途クエリ項目 kwic=1 を指定する事で Keyword In Context 機能も利用可能 (詳細はこちらを参照)。 フリーワードを指定して、かつ並び順 order に何も指定しない場合、検索結果は「フリーワードマッチ順」でソートされます。 |
*1 | 例: スペイン語 |
| keyword_or | フリーワード(OR検索) | 文字コードはUTF8。半角スペース区切りの文字列 (最大5単語まで) を渡すことでOR検索になる。上記フリーワード (keyword) 指定がある場合、こちらは無視される。複数指定可能*2。 別途クエリ項目 kwic=1 を指定する事で Keyword In Context 機能も利用可能 (詳細はこちらを参照)。 フリーワードを指定して、かつ並び順 order に何も指定しない場合、検索結果は「フリーワードマッチ順」でソートされます。 |
*1 | 例: 英会話 パソコン |
| kwic | KWICレスポンス設定 | クエリ項目「フリーワード」を利用の際、追加でこの kwic に値 1 を指定する事で API レスポンスに KWIC コンテンツを追加させる事ができます (詳細はこちらを参照) 。 | 例:1 | |
| type | 出力タイプ | レスポンス項目の項目数を指定できます。liteを指定すると、主要項目のみ出力されます。出力項目はレスポンスフィールドを参照してください。 | tiny:最小限の項目のみ、lite:主要項目のみ(デフォルト)、full:全て | |
| order | ソート順 | 0:PCサイトでののソート順（デフォルト）、1:携帯サイトでのソート順。 明示的に指定しない場合はPCサイトのソート順と同じになりますが、keyword,kwyord_orと併用の場合はフリーワードマッチになります。order=0を明示的につければ、keyword,keyword_orを併用したときも、PCサイトのソート順になります |
初期値:0 | |
| start | 検索の開始位置 | 検索結果の何件目から出力するかを指定します。 | 初期値:1 | |
| count | 1ページあたりの取得数 | 検索結果の最大出力データ数を指定します。 | 初期値：10、最小1、最大100 | |
| format | レスポンス形式 | レスポンスをXMLかJSONかJSONPかを指定します。JSONPの場合、さらにパラメータ callback=コールバック関数名 を指定する事により、javascript側コールバック関数の名前を指定できます。 | 初期値:xml。xmlまたはjsonまたはjsonp |
- *1：いずれか最低1つが必要
- *2：複数可のパラメータの指定方法
name=value1&name=value2&...または name=value1,value2,...
個数の上限が指定されてる場合は、その数を超えたパラメータは無視されます。
サンプルクエリ
カテゴリーコード（K030108）で絞り込む
※実際にご利用いただくには新規登録をした上で、取得したご自身のAPIキーをGETパラメータに加えていただく必要があります。
レスポンスフィールド
| フィールド | 説明 | 例 | full | lite | tiny |
|---|---|---|---|---|---|
| results | ○ | ○ | ○ | ||
| api_version | APIのバージョン | 1.01 | ○ | ○ | ○ |
| results_available | クエリー条件にマッチする、検索結果の全件数 | 7 | ○ | ○ | ○ |
| results_returned | このＸＭＬに含まれる検索結果の件数 | 7 | ○ | ○ | ○ |
| results_start | 検索結果の開始位置 | 1 | ○ | ○ | ○ |
| kouza | 講座 [複数要素] | ○ | ○ | ○ | |
| code | 講座コード | 0102030405 | ○ | ○ | ○ |
| name | 講座名 | プロネイリスト導入コース/検定3級対応 | ○ | ○ | ○ |
| mobile | 携帯サイトの有無 | 1 | ○ | ○ | ○ |
| capsule | カプセル | ○ | ○ | ○ | |
| code | カプセルコード | K030140 | ○ | - | - |
| name | カプセルコード名 | スポーツインストラクター | ○ | ○ | ○ |
| category | カテゴリ | ○ | ○ | ○ | |
| code | カテゴリコード | K20017 | ○ | - | - |
| name | カテゴリ名 | 音楽・ダンス・スポーツ | ○ | ○ | ○ |
| kind | 区分 01:テーマ 02:ジャンル | 01 | ○ | - | - |
| kigyo_daigaku_kbn | 企業大学区分 | 1 | ○ | - | - |
| kyufu | 給付金制度の有無 | 0 | ○ | ○ | - |
| tensaku | 添削の有無と方式 | ○ | - | - | |
| code | 添削コード | K030140 | ○ | - | - |
| name | 添削コード名 | スポーツインストラクター | ○ | - | - |
| schooling | 通学の有無 | 0 | ○ | - | - |
| setsumei | 説明会の有無 | 0 | ○ | - | - |
| catch_copy | 講座のキャッチコピー | ダイエットにも役立つ知識と資格です！ | ○ | ○ | - |
| kouza_feature | 講座の特徴 | ○ | ○ | - | |
| desc | 説明 | 【6ヵ月で目指せるスキル】SHOPに... | ○ | ○ | - |
| curriculum_feature | カリキュラムの特徴 | ○ | ○ | - | |
| desc | 説明 | 添削指導もプロ目線の的確なアドバイスが返ってく... | ○ | ○ | - |
| price | 費用 | 50000 | ○ | - | - |
| price_text | 費用文字列 | 50,000円 | ○ | ○ | ○ |
| price_note | 費用の補足 | 試験合格後資格認定料別途1万円 | ○ | ○ | - |
| payment_example | 支払い例 | 分割3,200円を23回払い＋初回3,334円 | ○ | ○ | - |
| term | 平均受講期間 | 約10ヶ月 | ○ | ○ | - |
| pace | 受講ペースの目安 | 60分/日 5日/週 | ○ | - | - |
| tensaku_num | 添削回数 | 4回(レポート提出) | ○ | ○ | - |
| extension | 期間の延長 | なし | ○ | - | - |
| materials | 送付物 | ○ | ○ | - | |
| photo | 送付物の画像 | http://...image_11.jpg | ○ | ○ | - |
| photo_mobile | 送付物の画像（モバイル向け) | http://...image_11.jpg | ○ | ○ | - |
| desc | 送付物の説明 | ストレッチの仕方、有酸素運動エクササイズとは... | ○ | ○ | - |
| spec | 画像と画像のコピー | ○ | ○ | - | |
| photo | 画像 | http://...image_11.jpg | ○ | ○ | - |
| desc | 画像のコピー | ストレッチの仕方、有酸素運動エクササイズとは... | ○ | ○ | - |
| extra | 講座の追加説明 | ○ | ○ | - | |
| feature | 特徴[複数要素] | ○ | ○ | - | |
| photo | 画像 | http://...image_11.jpg | ○ | ○ | - |
| title | キャッチコピー | 終了後の仕事探しも安心！ | ○ | ○ | - |
| desc | 特徴説明 | 知識と技術を習得した証として資格を認定... | ○ | ○ | - |
| urls | 詳細ページへのURL | ○ | ○ | ○ | |
| mobile | リンク先URL (携帯) | http://.../ | ○ | ○ | ○ |
| pc | リンク先URL (PC) | http://.../..._ | ○ | ○ | ○ |
| qr | リンク先URL (QRコード) | http://.../common/qr?url= | ○ | ○ | ○ |
| shiryo_flag | 資料請求ページへのリンクの有無。このフラグが1のときのみ。shiryo_urlsにリンク先がレスポンスされます | 1 | ○ | ○ | ○ |
| shiryo_urls | 資料請求ページへのURL | ○ | ○ | ○ | |
| mobile | リンク先URL (携帯) | http://.../ | ○ | ○ | ○ |
| pc | リンク先URL (PC) | http://.../..._ | ○ | ○ | ○ |
| qr | リンク先URL (QRコード) | http://.../common/qr?url= | ○ | ○ | ○ |
| school | 学校情報 | ○ | ○ | ○ | |
| code | スクールコード | SO00000 | ○ | - | - |
| name | 学校名 | メディアテクノロジーラボ学校 | ○ | ○ | ○ |
| name_kana | 学校名カナ | メディアテクノロジーラボガッコウ | ○ | ○ | ○ |
| address | 住所 | 東京都中央区銀座 | ○ | - | - |
| tel | 電話番号 | 03-XXXX-XXXX | ○ | - | - |
| mob_tel | 携帯電話番号 | 090-XXXX-XXXX | ○ | - | - |
カテゴリマスタ API
カテゴリの一覧を取得できます。区分を指定する事で、ジャンルとテーマごとの一覧をそれぞれ取得できます。
リクエストURL
検索クエリ
| パラメータ | 項目名 | 説明 | 必須 | 値 |
|---|---|---|---|---|
| key | APIキー | APIを利用するために割り当てられたキーを設定します。 | ○ | |
| category | カテゴリ | カテゴリ毎のコード。複数指定可能*1 | (例) K010020 | |
| kind | 区分 | テーマまたはジャンルごとに絞り込む事ができます。 01:テーマ 02:ジャンル |
(例) 01 | |
| start | 検索の開始位置 | 検索結果の何件目から出力するかを指定します。 | 初期値:1 | |
| count | 1ページあたりの取得数 | 検索結果の最大出力データ数を指定します。 | 初期値：10、最小1、最大100 | |
| format | レスポンス形式 | レスポンスをXMLかJSONかJSONPかを指定します。JSONPの場合、さらにパラメータ callback=コールバック関数名 を指定する事により、javascript側コールバック関数の名前を指定できます。 | 初期値:xml。xmlまたはjsonまたはjsonp |
- *1：複数可のパラメータの指定方法
name=value1&name=value2&...または name=value1,value2,...
個数の上限が指定されてる場合は、その数を超えたパラメータは無視されます。
サンプルクエリ
カテゴリ一覧を取得
※実際にご利用いただくには新規登録をした上で、取得したご自身のAPIキーをGETパラメータに加えていただく必要があります。
レスポンスフィールド
| フィールド | 説明 | 例 |
|---|---|---|
| results | ||
| api_version | APIのバージョン | 1.01 |
| results_available | クエリー条件にマッチする、検索結果の全件数 | 7 |
| results_returned | このＸＭＬに含まれる検索結果の件数 | 7 |
| results_start | 検索結果の開始位置 | 1 |
| category | カテゴリ [複数要素] | |
| code | カテゴリコード | K010020 |
| name | カテゴリ名 | 整体・カイロ・ボディケア |
| kind | 区分 | 01 |
カプセルマスタ API
カプセルの一覧を取得できます。区分を指定する事で、ジャンルとテーマごとの一覧をそれぞれ取得できます。
リクエストURL
検索クエリ
| パラメータ | 項目名 | 説明 | 必須 | 値 |
|---|---|---|---|---|
| key | APIキー | APIを利用するために割り当てられたキーを設定します。 | ○ | |
| capsule | カプセル | カプセル毎のコード。複数指定可能*1 | (例) K020020 | |
| category | カテゴリ | カテゴリ毎のコード。複数指定可能*1 | (例) K010020 | |
| kind | 区分 | テーマまたはジャンルごとに絞り込む事ができます。 01:テーマ 02:ジャンル |
(例) 01 | |
| keyword | キーワード | フリーワード | (例) エステ・美容 | |
| start | 検索の開始位置 | 検索結果の何件目から出力するかを指定します。 | 初期値:1 | |
| count | 1ページあたりの取得数 | 検索結果の最大出力データ数を指定します。 | 初期値：10、最小1、最大100 | |
| format | レスポンス形式 | レスポンスをXMLかJSONかJSONPかを指定します。JSONPの場合、さらにパラメータ callback=コールバック関数名 を指定する事により、javascript側コールバック関数の名前を指定できます。 | 初期値:xml。xmlまたはjsonまたはjsonp |
- *1：複数可のパラメータの指定方法
name=value1&name=value2&...または name=value1,value2,...
個数の上限が指定されてる場合は、その数を超えたパラメータは無視されます。
サンプルクエリ
カプセル一覧を取得
※実際にご利用いただくには新規登録をした上で、取得したご自身のAPIキーをGETパラメータに加えていただく必要があります。
レスポンスフィールド
| フィールド | 説明 | 例 |
|---|---|---|
| results | ||
| api_version | APIのバージョン | 1.01 |
| results_available | クエリー条件にマッチする、検索結果の全件数 | 7 |
| results_returned | このＸＭＬに含まれる検索結果の件数 | 7 |
| results_start | 検索結果の開始位置 | 1 |
| capsule | カプセル [複数要素] | |
| code | カプセルコード | K020020 |
| name | カプセル名 | エステ・美容 |
| category | カテゴリ | |
| code | カテゴリコード | K010020 |
| name | カテゴリ名 | ビューティー |
| kind | 区分 | 01 |
![[5]](/common/images/ref-num5.gif)
エラー時のレスポンス
<?xml version="1.0" encoding="UTF-8"?>
<results xmlns="http://webservice.recruit.co.jp/tsushin/">
<api_version>1.00</api_version>
<error>
<message>keyは必須パラメーターです</message>
</error>
</results>
エラーの際でも、HTTPレスポンスステータスは常に "200 OK" が返ります。実装側では常にレスポンスXMLの内容を見てエラー判断を行ってください。
![[6]](../common/images/ref-num6.gif)
Flashからの利用方法
Flash Action Script 2.0にて本APIを利用するには1フレーム目に下記の記述を追加する必要があります:
System.security.loadPolicyFile("http://webservice.recruit.co.jp/tsushin/crossdomain.xml");
このように crossdomain.xml を指定する事で、ご自身のサイト上にある Flash SWF ファイルから、本APIを利用することが可能になります。
