REST API

REST APIについて

  • 様々な情報の追加、更新、削除及び検索を行うことができます。
  • 様々な情報にはそれぞれ「データタイプ」という固有の識別子を持っています。APIではデータタイプを指定することで、処理対象とする情報を区別しています。
  • 利用申請時に、利用したいデータタイプをご申請ください。
  • 利用申請時に、認証を行うユーザ名とパスワードを発行いたします。APIのデータ中にユーザ名とパスワードを設定してサーバへ送信し、サーバで認証を行います。

提供データの区分について

  • 本システムでは提供するデータの保存する仕組みにより以下のように定めています。
No データ区分名 説明
1 最新データ 最後に追加または更新されたデータ
2 履歴データ 最新データの追加及び更新を世代管理できるように保存したデータ

使用するプロトコルについて

  • REST APIで利用するプロトコルは以下です。
項目 規格
プロトコル HTTP 1.0, 1.1
メソッド POST
コンテンツタイプ(Content-Type) application/json; charset=utf-8
文字コード UTF-8
リクエスト(送信)時のメッセージボディ形式 JSON
レスポンス(受信)時のメッセージボディ形式 JSON
http通信のサポート
サポートしております
なおhttp通信は、2021年3月17日 20:00 をもって終了予定です。
httpsのTLS 1.2を利用した通信へ移行をお願いいたします。
https通信のサポート
TLS 1.2、TLS 1.1、TLS 1.0をサポート
なおTLS 1.1、TLS 1.0は、2021年3月17日 20:00 をもって終了予定です。
TLS 1.2を利用した通信へ移行をお願いいたします。
APIサーバ https://api-w01.pf.iij-engineering.co.jp/

サーバ一覧

  • REST APIのリクエストを受け入れるサーバは以下です。
  • 以下のサーバに「REST API一覧」に記述したリクエストURLパスを追加したURLがAPIのエンドポイントURLになります。
リージョン URL
日本 https://api-w01.pf.iij-engineering.co.jp/

REST API一覧

No HTTPメソッド リクエストURLパス データ形式 概要 詳細
1 POST /info/1.0/data/get.json JSON 最新データから指定したidに合致するデータを取得する。(複数指定可能) 詳細: REST API 最新データ 取得
2 POST /info/1.0/data/search.json JSON 最新データから指定した検索条件に合致するデータを取得する。 詳細: REST API 最新データ 検索
3 POST /info/1.0/data/set.json JSON 最新データにデータを追加又は更新を行う。(複数指定可能) 詳細: REST API 最新データ 登録/更新
4 POST /info/1.0/data/delete.json JSON 最新データから指定したidに合致するデータを削除する。(複数指定可能) 詳細: REST API 最新データ 削除
5 POST /info/1.0/history/get.json JSON 履歴データからidを検索キーとして、履歴データを取得する。(複数指定可能) 詳細: REST API 履歴データ 取得
6 POST /info/1.0/history/get_context.json JSON 履歴データから指定した最新データのidに合致するデータを取得する。 詳細: REST API 履歴データ 更新履歴取得
7 POST /info/1.0/history/search.json JSON 履歴データから指定した検索条件に合致するデータを取得する。 詳細: REST API 履歴データ 検索