API利用ガイド

FrontPage

API利用ガイド

事前情報の取得†

モバイルダイエットAPIの使用に当たっては、以下の各設定情報が必要となる。
（※使用に際し弊社より発行します）

アプリケーションキー†

モバイルダイエットAPIを使用するためには、アプリケーションキーが必要である。
アプリケーションキーは、アプリケーションキーとアプリケーションシークレットからなるペアで、APIへのアクセス権限を認証するために使用される。

APIタイプと認証†

APIにおける認証は、次の２つのタイプのいずれか、または認証無しとなる。

認証についてはAPI認証を参照。

APIサーバー名・アクセスコード†

モバイルダイエットAPIのエントリポイントは、サーバー名とアクセスコードを使用して構成する。
原則として以下の構成を取る。

アクセス元IPアドレス†

アクセスは、IPアドレスに基づいてアクセスを制限できる。

APIへのアクセス†

使用可能なメソッド†

メソッドは使用する機能に応じて GET または POST のいずれかを使用できる。
但し、multipart/form-data でデータを受け渡す際は、POSTを用いる。

必須のリクエストヘッダ†

以下のリクエストヘッダは必ず送出しなければならない。

Host: (アクセスするAPIのホスト名)

文字コード†

APIで使用する文字コードは原則UTF-8とする。これ以外の文字コードはサポート対象外である。

ハッシュ値†

API中でのハッシュ値の表記は、半角英数0-9a-fを用い、文字列とする。

例: dc7faf3c5cd4a3d5e67a6c53ac919667d748969c

日付†

日付の書式は次の通りとし、タイムゾーンはJSTを用いる。

"YYYY/MM/DD"
YYYY: 4桁で表記する西暦
MM: 2桁で表記する月(01-12)
DD: 2桁で表記する日(01-31)

日付時刻†

日付時刻の書式は次の通りとし、タイムゾーンは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)

返値†

返却フォーマット†

特記なき限りjsonまたはxmlを用いる。

目次

• トップページ
• APIを使用する
• 各APIの詳細
• サンプルソース