Chi può usare questa funzione?
Disponibile suEnterprise piano.
Accessibile ai proprietari e agli amministratori su Web App.
Per utilizzare l'API Fax.Plus, è necessario prima concedere l'autorizzazione per l'API per accedere al proprio account. Dopo aver completato il processo di autorizzazione, è possibile accedere al proprio account.
Ci sono due metodi diversi per l'autenticazione:
- Genera e usa i token di accesso personale.
- Usa il flusso OAuth 2.0.
Un Personal Access Token può essere utilizzato come metodo di autenticazione per accedere in modo sicuro all'API Fax.Plus. Questo token serve come una firma digitale, che consente di fare richieste autorizzate alla nostra API, attivare azioni come l'invio di fax e il recupero dei dati ai vostri fax.
Segui questi passaggi per generare un nuovo Token di Accesso Personale:
- Accedi al tuo account Fax.Plus e vai alla sezione Profilosulla tua Dashboard.
- Trova la scheda per le integrazioni .
- Sotto Fax.Plus API, trova l'elemento per Personal Access Tokense clicca su Gestisci.
- Fare clic su Genera Tokene specificare il nome token, data di scadenzae ambiti (sia modificare che leggere come ambiti sul token).
- Assicurati di Copia il tuo Token di Accesso Personale ora, altrimenti non sarai in grado di vederlo di nuovo.
Passo 1: Impostare il flusso di autenticazione iniziale
- Accedi al tuo account Fax.Plus e vai alla sezione Profilosulla tua Dashboard.
- Trova la scheda per le integrazioni .
- Sotto Fax.Plus API, clicca su Activatee raccoglie i seguenti dati:
- Client ID (inizia con APIK-)
- Client secret
- Reindirizzare URI (uno di loro)
- Per avviare il processo di autorizzazione dell'API per accedere al tuo account, basta cliccare sul link fornito in questo passaggio utilizzando un browser web. Questo link ti reindirizzerà a un prompt dove puoi concedere i permessi necessari: https://accounts.fax. lus/login?response_type=code&client_id=[client ID]&redirect_uri=[redirect URI]&scope=all
-
Una volta concessa l'autorizzazione, verrai indirizzato all'URL specificato, accompagnato dal codice di autorizzazione come parametro URL:
Passo 2: Invia una richiesta HTTP POST
Dopo aver autorizzato l'accesso con successo, è possibile procedere per eseguire un HTTP POST al seguente URL: https://accounts.fax. lus/token?grant_type=authorization_code&client_id=[client ID]&code=[authorization code]&redirect_uri=[redirect URI].
Assicurati di includere le seguenti intestazioni nella tua richiesta:
-
- Tipo di contenuto: application/x-www-form-urlencoded
- Autorizzazione: Basic [base64-encoded string of "client_id:client_secret"]
- Tipo di contenuto: application/x-www-form-urlencoded
Una volta completato, riceverai una risposta contenente un token di accesso, che rimane valido per 1 ora, così come un token di aggiornamento con validità indefinita.
Nota: Se il vostro fax. lus account ha Advanced Security Control attivato, il token di aggiornamento rimane valido per 30 giorni in conformità alle norme di sicurezza. Questo implica che avrete bisogno di ripetere il processo ogni 30 giorni per ottenere un nuovo token di aggiornamento.
Passo 3: Ottieni un nuovo token di accesso
Una volta scaduto il token di accesso, è possibile ottenerne uno nuovo utilizzando il token di aggiornamento tramite una richiesta HTTP POST al seguente URL: https://accounts. ax. lus/token?grant_type=refresh_token&refresh_token=[refresh token].
Questo processo richiede l'inclusione delle seguenti intestazioni:
-
- Tipo di contenuto: application/x-www-form-urlencoded
- Autorizzazione: Basic [base64-encoded string of "client_id:client_secret"]
Dopo aver ottenuto il token di accesso, tutte le successive chiamate API richiederanno le seguenti intestazioni:
-
- Autorizzazione: Bearer [access token]
- x-fax-clientid: [client ID]