最初の API 認証フローを設定するにはどうすればよいですか?

この機能を使用できるのは誰ですか?

エンタープライズ プラン で利用できます。

ウェブアプリのオーナーと管理者にアクセスできます。

Fax.Plus API を使用するには、最初に API がアカウントにアクセスする許可を与える必要があります。 承認プロセスが完了すると、アカウントにログインできます。

認証には2つの異なる方法があります:

  1. パーソナルアクセストークンを生成して使用します。
  2. OAuth 2.0 フローを使用します
方法 1: パーソナルアクセストークンの生成と使用

パーソナルアクセストークン はFax.Plus APIに安全にアクセスするための認証方法として使用できます。 このトークンはデジタル署名として機能し、APIへの承認リクエストを行うことができます。 FAXの送信やデータの取得などのアクションを有効にします。

新しいパーソナルアクセストークンを生成するには、以下の手順に従ってください:

  1. Fax.Plus アカウントにログインし、ダッシュボードの Profileセクションに移動します。
  2. 統合 のタブを見つけます。
  3. Under FAX.PLUS API, find the item for Personal Access Tokens, and click on Manage.
  4. Click on Generate Token and specify the token name, expiration date, and scopes.
  5. Make sure to Copy your Personal Access Token now, otherwise you won't be able to see it again.
方法 2: OAuth 2.0 フローを使用して API がアカウントにアクセスすることを許可する

ステップ 1: 初期認証フローを設定

  1. Fax.Plus アカウントにログインし、ダッシュボードの Profileセクションに移動します。
  2. 統合 のタブを見つけます。
  3. Fax.Plus APIで、 をクリックし、以下のデータを収集します。
    • クライアントID(APIK-で始まる)
    • クライアントシークレット
    • リダイレクトURI (そのうちの1つ)

      FAX.PLUS-Authenticate.png

  4. アカウントにアクセスするAPIを承認するプロセスを開始するには、Webブラウザを使用して、このステップで提供されたリンクをクリックします。 This link will redirect you to a prompt where you can grant the necessary permissions: https://accounts.fax.plus/login?response_type=code&client_id=[client ID]&redirect_uri=[redirect URI]&scope=all

    FAX.PLUS-Authenticate-1.png

  5. パーミッションが付与されると、指定した URL にリダイレクトされ、URL パラメータとして認可コードが付与されます。

    FAX.PLUS-Authenticate-2.png


ステップ 2: HTTP POST リクエストを送信

After you have successfully authorized access, you can proceed to perform an HTTP POST to the following URL: https://accounts.fax.plus/token?grant_type=authorization_code&client_id=[client ID]&code=[authorization code]&redirect_uri=[redirect URI].

Make sure to include the following headers in your request:

    • Content-Type: application/x-www-form-urlencoded
    • Authorization: Basic [client_id:client_secret"]


FAX.PLUS-Authenticate-3.png

完了すると、アクセストークンを含むレスポンスが表示されます。 有効期限がないリフレッシュトークンと同様、1時間のままです。

ノート: ファックスの場合。 lusアカウントにはAdvanced Security Controlが有効になっており、リフレッシュトークンはセキュリティ規制に従って30日間有効となります。 これは、新しい更新トークンを取得するために30日ごとにプロセスを繰り返す必要があることを意味します。


ステップ 3: 新しいアクセストークンを取得

Once your access token has expired, you can obtain a fresh one using your refresh token through an HTTP POST request to the following URL: https://accounts.fax.plus/token?grant_type=refresh_token&refresh_token=[refresh token].

This process requires the inclusion of the following headers:

    • Content-Type: application/x-www-form-urlencoded
    • Authorization: Basic [client_id:client_secret"]

 

FAX.PLUS-Authenticate-4.png

 

アクセストークンを取得した後、以降のすべての API コールには以下のヘッダーが必要になります。

    • 認証: ベアラー[アクセストークン]
    • x-fax-clientid: [client ID]
 
 
この記事は役に立ちましたか?
0人中0人がこの記事が役に立ったと言っています
More Articles in this section