Passer au contenu principal

​
Apercu

TXCloud utilise des cles API pour authentifier les requetes. Toutes les requetes API doivent inclure votre cle API dans l’en-tete Authorization en utilisant l’authentification par jeton Bearer. 
Authorization: Bearer txc_live_votre_cle_api_ici

​
Types de Cles API

TXCloud fournit deux types de cles API :
TypePrefixeCas d’Utilisation
Test/Sandboxtxc_test_Developpement et tests
Live/Productiontxc_live_Applications en production
N’exposez jamais vos cles API dans le code cote client. Les cles API ne doivent etre utilisees que dans les applications cote serveur.

​
Obtenir Votre Cle API

1

Connectez-vous au Tableau de Bord

Allez sur dashboard.txcloud.io et connectez-vous.
2

Accedez aux Cles API

Cliquez sur Parametres dans la barre laterale, puis selectionnez Cles API.
3

Creez une Nouvelle Cle

Cliquez sur Creer une Cle API et configurez :
  • Nom : Un nom descriptif (ex: “Serveur Production”)
  • Environnement : Test ou Live
  • Permissions : Selectionnez les APIs auxquelles la cle peut acceder
  • Liste Blanche IP : (Optionnel) Restreindre a des IPs specifiques
4

Copiez Votre Cle

Copiez la cle immediatement - elle ne sera plus affichee !

​
Faire des Requetes Authentifiees

import TXCloud from '@txcloud/sdk';

// Le SDK gere l'authentification automatiquement
const txcloud = new TXCloud({
  apiKey: process.env.TXCLOUD_API_KEY
});

// Toutes les requetes sont automatiquement authentifiees
const verification = await txcloud.identity.verify({
  document_front: '...',
  country: 'MA'
});

​
Permissions des Cles API

Lors de la creation d’une cle API, vous pouvez restreindre l’acces a des APIs specifiques :
PermissionDescription
identity:readLire les resultats de verification
identity:writeCreer de nouvelles verifications
fraud:readLire les signaux de fraude et analytics
fraud:writeConfigurer les regles de fraude et listes de blocage
transactions:readLire les scores de transaction
transactions:writeScorer les transactions, mettre a jour les regles
lending:readLire les evaluations de credit
lending:writeCreer des evaluations, telecharger des releves
kyb:readLire les verifications d’entreprise
kyb:writeCreer des verifications d’entreprise
watchlist:readLire les resultats de filtrage
watchlist:writeFiltrer les entites, gerer les listes
developers:readLire l’utilisation API et les logs
developers:writeGerer les webhooks et parametres
Suivez le principe du moindre privilege - n’accordez que les permissions dont chaque cle a besoin.

​
Liste Blanche IP

Pour une securite supplementaire, vous pouvez restreindre les cles API a des adresses IP specifiques : 
{
  "name": "Cle API Production",
  "allowed_ips": [
    "203.0.113.50",
    "203.0.113.51",
    "10.0.0.0/8"  // Notation CIDR supportee
  ]
}
La liste blanche IP est optionnelle mais recommandee pour les cles de production.

​
Rotation des Cles

Nous recommandons de faire tourner vos cles API periodiquement :
1

Creez une Nouvelle Cle

Creez une nouvelle cle API avec les memes permissions.
2

Mettez a Jour Votre Application

Deployez la nouvelle cle dans votre application.
3

Verifiez que la Nouvelle Cle Fonctionne

Confirmez que les requetes reussissent avec la nouvelle cle.
4

Revoquez l'Ancienne Cle

Supprimez l’ancienne cle API du tableau de bord.
La revocation d’une cle est immediate et irreversible. Assurez-vous d’avoir mis a jour toutes les applications au prealable.

​
En-tetes Requis

Chaque requete API doit inclure ces en-tetes :
En-teteRequisDescription
AuthorizationOuiJeton Bearer avec votre cle API
Content-TypeOui (POST/PUT)application/json
Idempotency-KeyRecommandeCle unique pour des re-essais surs
X-Request-IDOptionnelVotre ID de requete pour le tracage
curl -X POST https://api.txcloud.io/v1/identity/verify \
  -H "Authorization: Bearer txc_live_xxx" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: id-requete-unique-123" \
  -H "X-Request-ID: mon-id-trace-456" \
  -d '{"document_front": "..."}'

​
Erreurs d’Authentification

Code ErreurStatut HTTPDescription
unauthorized401Cle API manquante ou invalide
forbidden403La cle n’a pas les permissions requises
ip_not_allowed403Requete depuis une IP non autorisee
key_revoked401La cle API a ete revoquee
key_expired401La cle API a expire

​
Exemple de Reponse d’Erreur

{
  "error": {
    "code": "unauthorized",
    "message": "Cle API invalide fournie",
    "type": "authentication_error",
    "request_id": "req_a1b2c3d4"
  }
}

​
Bonnes Pratiques

Stockez les cles API dans des variables d’environnement, pas dans le code :
export TXCLOUD_API_KEY="txc_live_xxx"
Creez des cles separees pour le developpement, le staging et la production.
Verifiez regulierement le tableau de bord pour detecter toute activite inhabituelle.
Restreignez les cles de production aux IPs de serveur connues.
Faites tourner les cles de production tous les 90 jours.

​
Prochaines Etapes

Limites de Debit

Comprendre les limites de debit API

Gestion des Erreurs

Gerer les erreurs avec elegance