- 追加された行はこの色です。
- 削除された行はこの色です。
- API利用ガイド へ行く。
[[FrontPage]]
&size(24){API利用ガイド};
#contents
* 事前情報の取得 [#ae05b06f]
モバイルダイエットAPIの使用に当たっては、以下の各設定情報が必要となる。~
（※使用に際し弊社より発行します）
** アプリケーションキー [#b6fdcef1]
モバイルダイエットAPIを使用するためには、アプリケーションキーが必要である。~
アプリケーションキーは、アプリケーションキーとアプリケーションシークレットからなるペアで、APIへのアクセス権限を認証するために使用される。
** APIタイプと認証 [#b6fdcef1]
APIにおける認証は、次の２つのタイプのいずれか、または認証無しとなる。
|APIタイプ|認証内容|h
|ユーザー系API|アプリケーション及びユーザーを認証する|
|データ系API|アプリケーションのみを認証する|
認証については[[API認証]]を参照。
** APIサーバー名・アクセスコード [#x9d809f5]
モバイルダイエットAPIのエントリポイントは、サーバー名とアクセスコードを使用して構成する。~
原則として以下の構成を取る。
|APIタイプ|URL|h
|ユーザー系API|https://(サーバー名)/services/api/(アクセスコード)/|
|データ系API|https://(サーバー名)/services/api/(アクセスコード)/(エントリ)|
** アクセス元IPアドレス [#i494454e]
アクセスは、IPアドレスに基づいてアクセスを制限できる。
* APIへのアクセス [#f12bbe0e]
** 使用可能なメソッド [#ve87dd44]
メソッドは使用する機能に応じて GET または POST のいずれかを使用できる。~
但し、multipart/form-data でデータを受け渡す際は、POSTを用いる。
** 必須のリクエストヘッダ [#l0690088]
以下のリクエストヘッダは必ず送出しなければならない。
Host: (アクセスするAPIのホスト名)
** 文字コード [#z68ec85f]
APIで使用する文字コードは原則UTF-8とする。これ以外の文字コードはサポート対象外である。
** ハッシュ値 [#yc4fc25f]
API中でのハッシュ値の表記は、半角英数0-9a-fを用い、文字列とする。
例: dc7faf3c5cd4a3d5e67a6c53ac919667d748969c
** 日付 [#be833f76]
日付の書式は次の通りとし、タイムゾーンはJSTを用いる。
"YYYY/MM/DD"
YYYY: 4桁で表記する西暦
MM: 2桁で表記する月(01-12)
DD: 2桁で表記する日(01-31)
** 日付時刻 [#sb505a7d]
日付時刻の書式は次の通りとし、タイムゾーンはJSTを用いる。
"YYYY/MM/DD hh:mm:ss"
YYYY: 4桁で表記する西暦
MM: 2桁で表記する月(01-12)
DD: 2桁で表記する日(01-31)
hh: 2桁で表記する時(00-23)
mm: 2桁で表記する分(00-59)
ss: 2桁で表記する秒(00-59)
* 返値 [#rd31ae9b]
** 返却フォーマット [#zee1b52e]
特記なき限りjsonまたはxmlを用いる。
![[PukiWiki]](image/pukiwiki.png "[PukiWiki]")
