Créer un accès précis à l'API Fax.Plus avec des jetons d'accès personnels

Les jetons d'accès personnels (PAT) offrent un accès sécurisé et précis à l'API Fax.Plus. Ce guide vous explique comment créer et gérer des jetons avec les autorisations adaptées aux besoins de votre intégration.

Créer un jeton d'accès personnel

Génération du jeton d'accès

1. Connectez-vous à votre tableau de bord Fax.Plus sur app.fax.plus
2. Accédez à Paramètres > Integrations > Personal Access Tokens
3. Cliquez sur « Generate New Token »

Configuration du jeton

Lors de la génération d'un nouveau jeton, vous devez configurer les éléments suivants :

1. Token Name : choisissez un nom descriptif qui indique l'usage du jeton
2. Expiration : définissez une date d'expiration personnalisée (recommandé : 90 jours)

Scopes disponibles

Sélectionnez un ou plusieurs des scopes suivants pour définir les autorisations d'accès du jeton :

Accès général

• fax:all:read

  - Accès en lecture seule à toutes les opérations liées aux fax

  • Consulter les fax, les utilisateurs, les membres et les numéros
• fax:all:edit

   - Accès complet à toutes les opérations liées aux fax

  • Gérer les fax, les utilisateurs, les membres, les webhooks et les numéros

Gestion des webhooks

• fax:webhook:read- Consulter les configurations des webhooks

• fax:webhook:edit- Gestion complète des webhooks

Opérations de fax

• fax:fax:read

  - Accès à la consultation des fax

  • Consulter la boîte d'envoi, les fichiers de fax et les rapports
• fax:fax:edit

  - Autorisations de gestion complète des fax 

  • Gérer la boîte d'envoi, les fichiers et les détails des fax

Gestion des utilisateurs

• fax:use:read

  - Consulter les informations de l'utilisateur actuel (propriétaire du PAT)

• fax:user:edit

   - Modifier les informations de l'utilisateur actuel

Fonctionnalités de la boutique

• fax:shop:read

  - Parcourir les numéros de fax et consulter le solde de crédit

• fax:shop:edit

  - Acheter des numéros

Accès des membres

• fax:member:read

  - Consulter les informations du compte et des membres

• fax:member:edit

  - Gérer les informations des membres

Gestion des numéros

• fax:numbers:read

   - Lister et consulter les numéros de fax

• fax:numbers:edit

   - Gestion complète des numéros de fax

Bonnes pratiques de sécurité

1. Principe du moindre privilège
   • Accordez uniquement les scopes strictement nécessaires à votre intégration
   • Utilisez des scopes en lecture seule lorsque l'accès en écriture n'est pas nécessaire
2. Rotation des jetons
   • Renouvelez vos jetons tous les 90 jours
   • Programmez un rappel pour la rotation des jetons
   • Créez de nouveaux jetons avant l'expiration des anciens afin d'assurer la continuité du service
3. Gestion des jetons
   • Protégez vos jetons et ne les partagez jamais
   • Révoquez immédiatement tout jeton compromis
   • Stockez vos jetons de façon sécurisée dans la configuration de votre application

Conseils de mise en œuvre

1. Sélection des scopes

   • Pour les opérations en lecture seule, utilisez les scopes 

     *:read

   • Pour une gestion complète, utilisez les scopes 

     *:edit

   • Envisagez d'utiliser 

     fax:all:read

     ou 

     fax:all:edit

      pour des besoins d'accès étendus

2. Tests
   • Testez d'abord votre intégration avec un minimum de scopes
   • Ajoutez des scopes progressivement, selon vos besoins
   • Vérifiez la gestion de l'expiration du jeton dans votre application

Dépannage

Si vous rencontrez des problèmes d'accès :

1. Vérifiez que le jeton n'a pas expiré
2. Assurez-vous d'avoir sélectionné tous les scopes requis
3. Vérifiez si le jeton a été révoqué
4. Assurez-vous d'utiliser correctement le jeton dans les requêtes API

Les jetons d'accès personnels sont actuellement gérés par utilisateur : chaque membre de l'équipe crée et révoque ses propres jetons dans Paramètres > Integrations > Personal Access Tokens. Il n'existe pour l'instant aucun contrôle administrateur en libre-service permettant de révoquer ou de désactiver les PAT des autres membres du compte.