サービス・リクエスト
REST APIは、サービス・リクエストの直接URLとJSONデータ形式をサポートしています。
REST API for Documentsには、サービス・リクエストの例が含まれています。
URLパラメータ
特に断りのないかぎり、サービス・リクエスト・パラメータはURLに直接含めることができます。 次の「ユーザーの問合せ(GET)」サービス・コールの例では、URL自体に必要なinfoパラメータが含まれています:
https://www.example.com/documents/api/1.1/users/items?info=smith
JSONパラメータ
特に断りのないかぎり、サービス・リクエスト・パラメータはJSON形式で送信できます。 次の例は、JSON形式のリクエストの単純なサービス・コールとinfoパラメータを示しています:
https://www.example.com/documents/api/1.1/users/items
{
"info": "smith"
}
マルチパート・リクエスト
一部のサービス・コールでは、マルチパート・リクエストが必要です。 このようなタイプのリクエストでは、JSON形式のリクエストにパラメータを含める必要があります。 マルチパート・リクエストの例については、「ファイル」の「ファイルのバージョンのアップロード」の「例」タブを参照してください。
ヘッダー・パラメータ
認証情報などのある種の情報は、リクエストの本文ではなくリクエスト・ヘッダーで渡されます。 このことは、アプリケーション・リンク(applink)を使用するサービス・リクエストについても当てはまります。 Applinkにより、特定のファイルまたはフォルダ・リソースに対するアクセス権が特定のユーザーに付与されます。 Applinkを使用すると、そのリソースに対して関連ユーザーのかわりに他の操作を一定期間にわたってプログラム的に実行できます。 Applinkを使用するサービス・コールの場合、Applink識別子およびアクセス・トークンがヘッダー内に含まれます。
例については、Applinksの「Applinkトークンのリフレッシュ」の「例」タブのapplinkヘッダー・パラメータを参照してください。
アプリケーション・リンクの詳細は、Applinksを参照してください。