API連携キット

「まいと～く Center API連携キット」を購入することで、APIを利用してFAXサーバーシステムを構築するコンポーネントを操作することができます。

API連携キット ユーザー様およびご検討中のお客様へ

「API連携キット」をご購入いただいた方、またはお貸し出し中のお客様に専用ページをご用意しております。お客様のサポートIDを入力してご覧ください。

概要

「まいと～く Center API連携キット」を購入することで、Web API（HTTPリクエスト）またはAPI（.NET）を利用して、FAXサーバーシステムを構築するコンポーネントを操作することができます。「まいと～く Center」が提供するFAX通信機能、画像変換機能、ログ管理機能なども、APIを呼び出すことによって制御が可能になります。

既存システムと連携するアプリケーションからFAX通信の機能を利用したい、あるいは標準のFAX送信機能では実現できない複雑なFAXサーバーシステムを構築したい場合には、直接APIを利用することで、ニーズに合ったシステム構築が可能となります。

ご利用イメージ

ご利用イメージ

サポートについて

インシデント数の範囲で、弊社の技術スタッフがテクニカルサポートをご提供いたします。次の事項は、サポートサービスの対象外とします。

  1. システムの設計や運用のコンサルティング、お客様作成プログラムのデバッグやコンサルティングなどのお問い合わせ。
  2. 日本国外からのお問い合わせ、および日本語以外の言語でのお問い合わせ。
  3. 現地でのサポート。

ご利用に必要な知識/技術

API機能を利用するためには、以下の知識・技術が必要となります。

  • 使用するOSの操作、動作などに関する知識・技術
  • 使用するアプリケーションの操作、動作などに関する知識・技術
  • 使用するアプリケーションのマクロに関する知識・技術
  • 「まいと～く Center」のAPI機能に関する知識・技術
  • Microsoft Visual Basic、Microsoft Visual C#による言語プログラミングの知識・技術
  • .Netコンポーネントの利用に関する知識・技術

APIの基本的な利用の仕方

Web API（HTTPリクエスト）について

「まいと～く Center」の基本機能は、すべてREST形式のWeb APIで公開されています。このWeb APIには、HTTPリクエストができるプログラミング言語およびスクリプトからアクセスできます。
一般的なプログラミング言語による関数と対比すると、｢関数を呼ぶこと＝HTTPリクエストすること｣、｢戻り値を受け取ること＝リクエストに対するレスポンスを受け取ること｣となります。

API（.NET）について

「まいと～く Center」のAPI（.NET）は、必ず［Login］メソッド、［Logout］メソッドの発行が必要になります。［Login］メソッドを実行することにより、APIの実行認証が行われ、各メソッドが実行可能となります。

他のアプリケーションで作成された原稿をFAX送信する流れ
（プリンタードライバーを経由したFAX送信処理の流れ）
  1. 1.初期化

    メソッド：Login ()

    API［Login］メソッドを呼び出し、管理サーバーへの接続を通知します。

  2. 2.プリンタードライバーへのFAX文書ファイル名設定

    メソッド：SetPrintFileName ()

    API［SetPrintFileName］メソッドは、プリンタードライバー経由で出力されるTIFF原稿のファイル名を新規に指定します。

  3. 3.他のアプリケーションからの印刷

    イベント：NotifyPrintStatus () 印刷完了待機用

    他のアプリケーションからFAXの元になる原稿の印刷を行い、プリンタードライバーの印刷完了を、上記イベントで待機します（印刷方法は、使用するアプリケーションのマニュアルを参照してください）。

  4. 4.FAX送信要求

    メソッド：Send Fax ()

    FAX送信の開始要求（ジョブID受け取り）
    API［SendFax］メソッドで、送りたい相手先情報や、先ほど［SetPrintFileName］メソッドで指定したFAX原稿のTIFFファイルを指定し、FAX送信の要求を行います。
    ※別の相手先に別の原稿を送りたい場合、手順2からを繰り返し行います。

  5. 5.FAX送信完了

    イベント：NotifySendStatus ()

    FAX送信完了（ジョブIDにより判別）
    API［NotifySendStatus］イベントからの通知で、FAX送信が完了するまで処理を待機します。

  6. 6.後始末

    メソッド：Logout ()

    プログラムを終了する際、API［Logout］メソッドを呼び出し、管理サーバーとの接続を切断します。
    ※［Logout］メソッドは、イベント処理中に行った場合エラーになります。

  7. 7.アプリケーション終了
FAX受信処理の流れ
  1. 1.初期化

    メソッド：Login ()

    API［Login］メソッドを呼び出し、管理サーバーへの接続を通知します。

  2. 2.FAX受信開始

    メソッド：EnableReceiveFaxEvent ( true )

    受信通知の開始要求
    受信時のイベント通知を開始します。

  3. 3.FAX受信の通知

    イベント：NotifyReceiveStatus ()

    手順2の操作を実行した直後、受信ごとに［NotifyReceiveStatus］イベントが通知されます。

  4. 4.FAX受信終了

    メソッド：EnableReceiveFaxEvent ( false )

    受信通知の終了要求
    受信時のイベント通知を停止します。

  5. 5.後始末

    メソッド：Logout ()

    アプリケーション終了
    プログラムが終了する際、API［Logout］メソッドを呼び出し、管理サーバーとの接続を切断します。

  6. 6.アプリケーション終了
▲