使用するプロトコル
UOM-APIの呼び出しは、HTTP/1.1(https)を利用します。
- お客様が作成されたプログラムから、エンドポイントURLに対してリクエストしてください。
- httpのリクエストは受け付けません。必ずhttpsを使用してください。
- TLSバージョンは、1.2以上を指定してください。
- リクエスト先の正当性を確認するため、SSL証明書の検証を推奨します。
- 短期間に極めて多数のリクエストが行われた場合は、サービスの健全性を保つためにリクエストを制限することがあります。
リクエストはQuery形式、またはREST形式で送信してください。
- 指定できる形式はAPIごとに異なります。各APIの情報を確認してください。
- Query形式の場合
- リクエストパラメータがGETの場合は、QueryString形式をURLへ付加して送信してください。
- リクエストパラメータがPOSTの場合は、HTTPリクエストボディはapplication/x-www-formurlencoded形式で送信してください。
- POSTメソッドを用いる場合、Content-Type: multipart/form-data、Transfer-Encoding: chunkedには対応していません。
- レスポンスのフォーマットはJSON、またはXMLが利用できます。エンドポイントのURLパスに指定してください。
- REST形式の場合
- POSTメソッドを用い、HTTPリクエストボディはapplication/json形式で送信してください。
- レスポンスのフォーマットはJSONのみとなります。
UOM-APIのレスポンスフォーマットはJSON、またはXMLが利用できます。
- レスポンスフォーマットは、エンドポイントURLのパスを指定してください。
項目 | 規格 |
---|---|
プロトコル | HTTP/1.1(https) |
HTTPメソッド | GET または POST |
レスポンスフォーマット | JSON または XML(Query形式) JSON(REST形式) |
文字コード | UTF-8 |
タイムアウト | 180秒 |
エンドポイントURL | https://uom.api.iij.jp |