(5)権限が付与されれば2以降の操作が行えるようになります。
APIドキュメント(https://ninja-sign.com/v1/docs)に関しては、権限関係なく閲覧できるので、ご参照ください。
APIリクエストできる項目について、簡単に記載します。
7ー2〜10に関しては、2020年9月現在の説明です。最新のリクエストできる項目、および、リクエストとレスポンスの一覧の詳細に関してはAPIドキュメント( https://ninja-sign.com/v1/docs )を参照ください。
7-2.文書作成
7-3.文書一覧の取得
7-4.文書送信
7-5.検索項目付与
7-6.ユーザー一覧の取得
7-7.ユーザーの招待
7-8.ユーザーの退会
7-9.フォルダー一覧の取得
7-10.テンプレート一覧の取得
7-11.マイ印鑑一覧の取得
7-12.チーム一覧の取得
(1) https://ninja-sign.com/v1/docs にアクセスし、 「/v1/token アクセストークン発行API」をクリックするとアクセストークンの項目を開くことができます。
(2) 「Try it out」 をクリックすることで、 Request body を指定できるようになります。
(3)Request Body に3(2)で発行した client_id と client_secret を指定し、「Excute」をクリックします。
(4) リクエスト・レスポンス内容が表示されます。( access_token はレスポンスに含まれます。)
(5)続いて、 「Authorize」をクリックするとモーダルが開きます。
(6) value に 発行した access_token を入力します。
(7)access_tokenを入力できたら、「Authorize」をクリックします。
(8)「Close」をクリックし、モーダルを閉じます。
(9)この時点で、すべてのAPIリクエストをSwaggerUI上で試すことができます。(実際のデータで取得・作成・更新などを行うことができます。)
例として、「文書一覧の取得 」のAPIのリクエストを行う手順を記載していきます。
(10)「/v1/documents 契約書一覧の取得」をクリックし、 「Try it out」 をクリックする
(11)「Execute」 をクリックすることでリクエストができ、登録している契約書一覧の情報についてリクエスト・レスポンス内容を確認できます。
Webhook URLを登録しておくことで、freeeサインからそのURLに対してPOSTリクエストが送られます。Webhookの登録方法や詳細に関しては、freeeサイン Webhook をご参照ください。
© freee Sign All Rights Reserved.