API実行時の状態管理

作成するPDFコンテンツによっては、APIを実行する側の状態を引き継ぎたい場合があります。

特にログインが必要なシステムからPDFを出力したい場合には、誰がリクエストしているのかで制御をするケースが多くあります。
しかし、Quick2PDFのブラウザは利用者のブラウザ情報を引き継ぎません。したがって、Cookieなどの情報も利用出来ません。

ここでは、このような用途の場合にどのようにするかを紹介します。

URLのパラメータで引き継ぐ

最も簡単で多くのケースで共通な方法に、URLにGETパラメータを付与する事です。

Quick2PDFでは、GETパラメータを含めたURL情報に対して加工しないため利用が可能です。

Quick2PDFでは、APIの実行時に指定した値をWEB-PDFコンテンツを要求する際のリクエストにその値をひきつぐ方法が用意されています。

ウィジェットAPIの場合には、以下のようにstate変数を指定し、APIを実行します。
state変数に設定出来る文字列は、200文字以内で指定してください。また、リクエストヘッダに設定されますので英数字などで指定するようにしてください。

            window.Quick2PDF.start("/sample/pdf",{
                state : 'YPe5yvdY9MqK5dm33JNe'
            });
        

また、このコードを実行するとQuick2PDFからお客様のサーバに対してWEBコンテンツを要求するHTTPリクエストに次のヘッダと値が追加されます。

Last modified: 15 November 2024