API利用ガイド

FrontPage

API利用ガイド

事前情報の取得†

リクエストAPIの使用に当たっては、以下の各設定情報が必要となる。
（※使用に際し弊社より発行し、別途通知します）

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

APIのエントリポイントは、サーバー名とアクセスコードを使用して構成する。

アプリケーションキーペア†

APIの認証には、アプリケーションキー及びアプリケーションシークレットを使用する。キーペア、特にアプリケーションシークレットは、外部に漏洩しないよう配慮されなければならない。

アクセス元IPアドレスの制限†

APIはIPアドレスによってアクセスを制限する場合がある。 この場合、使用に際しては、アクセス元となるIPアドレスを設定する必要がある。（※弊社にて設定しますのでアドレスをお知らせ下さい）

httpsのSSL証明書†

httpsのSSL証明書には、Let's Encryptを使用する。発行者の署名を確認する必要がある場合には、Let's Encrypt のページからca-certificateを取得できる。

APIへのアクセス†

使用可能なメソッド†

メソッドは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)

返値†

HTTPレスポンスコード†

エラー時等、アクセスの条件、状態に応じて、返却されるHTTPレスポンスコードは以下の通り。

IPアドレス制限によってアクセスが拒否されている場合†

IPアドレス制限によってアクセスが拒否されている場合は、HTTPレスポンスコード403が返却される。

例:
$ curl -I "https://apiserver-mycode.mobadai.jp/services/api2/mycode/search/custom/json/カレー/0/50/"
HTTP/1.1 403 Forbidden
Date: Wed, 09 Dec 2020 20:51:11 GMT
Server: Apache
Content-Type: text/html; charset=iso-8859-1

アクセスしているURLまたはアクセスコードが間違っている†

アクセスしているURL、アクセスコード、フォーマットが誤っている場合は、HTTPレスポンスコード404が返却される。

例:
$ curl -I "https://apiserver-mycode.mobadai.jp/service/api2/mycode/search/custom/json/カレー/0/50/"
HTTP/1.1 404 Not Found
Date: Wed, 09 Dec 2020 20:52:22 GMT
Server: Apache
Content-Type: text/html; charset=iso-8859-1

$ curl -I "https://apiserver-mycode.mobadai.jp/services/api2/mycobe/search/custom/json/カレー/0/50/"
HTTP/1.1 404 Not Found
Date: Wed, 09 Dec 2020 20:53:05 GMT
Server: Apache
Content-Type: text/html; charset=iso-8859-1

返却フォーマット†

jsonを使用する。

目次

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