ja
フィンテック

APIドキュメント

クライアントサイト、バックオフィス、およびすべてのプラットフォームモジュールは、直接ではなく、APIを介してデータベースファイルを処理します。 APIは、受信データのアクセス、整合性、および正確性を制御します。

概要

APIはどのように機能しますか?

API-プラットフォームのキーノード

このドキュメントでは、次のアクションのすべてのAPIメソッドについて説明します。

  • オブジェクトのリストを取得する(listメソッド)
  • リストフィルタリング(フィルターデータを使用したリストメソッド)
  • オブジェクトに関する詳細情報の取得(showメソッド)
  • オブジェクトの追加フォームのデータの取得(addメソッド)
  • データを新しいオブジェクトとして保存する(storeメソッド)
  • オブジェクト更新フォームのデータの取得(編集メソッド)
  • 更新されたオブジェクトのデータを保存する(updateメソッド)

IPアドレスによる確認

APIは、限られたIPアドレスのリスト(たとえば、クライアントのアカウントサイトまたはバックオフィスサイト)からの要求のみを受け入れます。

許可リストにないIPアドレスからのAPIへのリクエストはすべて拒否されます。

これは、APIに対するDDoS攻撃、リクエストの改ざん、ハッカーの実験を防ぐために行われます。

ユーザーは常にプラットフォームのパブリックサイト(カスタマーオフィスまたはバックオフィス)にアクセスし、このサイト自体がプラットフォームのAPIから必要なデータを要求します。サイトのIPアドレスは固定されているため、許可リストに追加されます。

URLとメソッド

すべてのAPIリクエストは、次のHTTPメソッドを使用して行われます。

  • GET リスト、表示、追加、編集
  • POST ストア用
  • PUT 更新のため
  • DELETE 削除用

APIの各セクションには、関連データを取得するためのリクエストが行われるURLが含まれています。

HTTPリクエストメソッドは、各URLの前に指定されています。

リクエストを送信する

各APIリクエストには、常に4つの変数が含まれている必要があります。

  1. data (APIのデータ配列を含むjson文字列)
  2. user (現在のユーザーに関するデータの配列を含むjson文字列)
  3. time (UTCタイムゾーンの現在時刻)
  4. hash (APIへのリクエストが確実に許可されたソースからのものであることを確認するためのハッシュ形式のデジタル署名)

APIからの応答の取得

リクエストが成功すると、APIは常に2つの変数を返します。

  1. status = true (成功ステータス)
  2. data (APIからのデータ配列を含むjson文字列)

リクエストが失敗した場合、APIは変数を表示します。

  1. status = false (エラーステータス)
  2. error (エラーを説明するテキスト文字列)

デジタル署名

各APIリクエストには、リクエストのデジタル署名であるハッシュ変数が含まれている必要があります。

hash = md5($json . $time . $salt)

  • md5, sha256, bcrypt — 利用可能な暗号化アルゴリズム
  • $json — リクエストデータを含むjson文字列
  • $time — 「DD.MM.YYYYHH:MM:SS」形式の時間
  • $salt — プラットフォームAPIの一意の値(「ソルト」)を修正しました

フィンテック

ドキュメントには、実際のAPIリクエストの例が含まれています