リクエスト共通仕様
APIを介してECHOPFにアクセスするには、次の共通仕様に従ってリクエストを送信してください。
リクエスト送信先
リクエスト送信先のURLは、次の形式となります。
https://///rest_api=1.0/
| セキュアドメイン | アカウントに割り当てられているセキュアドメインを指定します。 |
|---|---|
| インスタンスID | アクセスするインスタンスをIDで指定します。 |
| リソースパス | アクセスするリソースタイプを指定します。 REST APIインタフェースに対応している個別のリソースの詳細仕様については、REST APIリファレンスをご参照ください。 |
リクエストヘッダー
リクエストヘッダーには次の情報を格納します。
「アプリケーションID」と「アプリケーションキー」は必須パラメータとなります。
| パラメータ名 | 説明 |
|---|---|
| X-ECHO-APP-ID | アプリケーションID：登録したAPIアプリケーションのアプリケーションIDを指定してください。 |
| X-ECHO-APP-KEY | アプリケーションキー：登録したAPIアプリケーションのアプリケーションキーを指定してください。 |
| X-ECHO- ACCESS-TOKEN |
アクセストークン：ログインセッションを維持した状態でアクセスするには、発行されたアクセストークンを指定してください。 アクセストークンは、メンバーログインの際に発行されます。 |
リクエストフォーマット(cURL)
curl -v -X GET/POST/PUT/DELETE \
-H "CONTENT-TYPE: application/json" \
-H "X-ECHO-APP-ID: アプリケーションID" \
-H "X-ECHO-APP-KEY: アプリケーションキー" \-H "X-ECHO-ACCESS-TOKEN: アクセストークン" \
"https://セキュアドメイン/インスタンスID/リソースパス/rest_api=1.0/" \
-d '{コンテントオブジェクト}'