Documentation API

Documentation API • Scanpaie

Documentation API Scanpaie

Retrouvez ici les informations essentielles pour comprendre, connecter et utiliser l’API SaaS Scanpaie dans les meilleures conditions.

Commencer Accéder à l’espace client

Accès sécurisé Intégration simple Clés API Support disponible

Démarrage Base URL Authentification Clés API Endpoints Réponses Support

Présentation

Une documentation claire pour bien démarrer

Cette page vous aide à comprendre le fonctionnement général de l’API, l’accès à votre compte, la gestion des clés API et les bonnes pratiques d’utilisation.

Étape 1

Obtenir un accès

Après souscription, votre compte est activé et vous pouvez accéder à votre espace client sécurisé.

Voir l’espace client

Étape 2

Créer une clé API

Une clé API vous permet d’authentifier vos appels et de sécuriser l’accès à vos services.

Voir la section clés API

Étape 3

Appeler l’API

Une fois votre clé active, vous pouvez interroger les endpoints mis à disposition.

Voir l’authentification

Étape 4

Être accompagné

En cas de question technique ou fonctionnelle, le support reste disponible selon votre formule.

Contacter le support

Démarrage rapide

Comment commencer

Créer votre compte

Après validation de votre abonnement, votre accès client est ouvert ou activé.

Se connecter

Connectez-vous à votre espace client pour gérer votre abonnement et vos accès API.

Générer votre clé API

Depuis votre tableau de bord, créez une clé API dédiée à votre utilisation.

Tester vos appels

Utilisez votre clé API dans vos requêtes pour tester l’accès aux endpoints disponibles.

Configuration

URL de base de l’API

Base URL

https://api.scanpaie.com

Tous les appels à l’API doivent être construits à partir de cette URL de base.

Authentification

Comment authentifier vos appels

L’accès à l’API repose sur une clé API unique associée à votre compte. Chaque requête doit transmettre cette clé dans les en-têtes afin d’être reconnue et autorisée.

Exemple d’en-tête

X-API-Key: votre_cle_api

Exemple cURL

curl -X GET "https://api.scanpaie.com/v1/resource" \
-H "X-API-Key: votre_cle_api"

Clés API

Gestion des clés API

Vos clés API sont disponibles depuis votre espace client. Elles servent à sécuriser les appels et doivent rester confidentielles.

Créer une clé API
Nommer une clé selon son usage
Révoquer une clé compromise
Créer une nouvelle clé si nécessaire

Bonnes pratiques

Ne jamais exposer votre clé publiquement
Ne pas partager votre clé par email non sécurisé
Créer une clé dédiée par usage si besoin
Révoquer immédiatement une clé compromise

Endpoints

Exemples d’endpoints disponibles

Méthode	Endpoint	Description
POST	/auth/login	Connexion d’un utilisateur à l’espace client
GET	/me	Récupération des informations du compte connecté
GET	/me/subscription	Consultation de la formule d’abonnement active
GET	/me/api-keys	Liste des clés API du compte
POST	/me/api-keys	Création d’une nouvelle clé API
GET	/v1/resource	Exemple d’accès à une ressource protégée

Réponses

Format de réponse

Exemple de réponse JSON

{
  "status": "success",
  "message": "Accès autorisé",
  "data": {
    "resource": "exemple"
  }
}

Les réponses sont généralement fournies au format JSON pour faciliter leur intégration dans vos outils.

Erreurs

Codes courants

200

La requête a été traitée avec succès.

401

Authentification invalide ou clé API absente.

403

Accès refusé ou abonnement non actif.

500

Erreur interne temporaire du serveur.

Support

Besoin d’aide pour l’intégration ?

Si vous avez une question sur l’accès, la configuration, l’authentification ou l’usage de votre API, notre équipe peut vous accompagner.

L’accompagnement dépend de votre formule et de votre niveau de service.

Nous pouvons vous aider sur :

Connexion à l’espace client
Création et gestion des clés API
Compréhension des endpoints
Résolution des erreurs d’accès

Prêt à utiliser l’API Scanpaie ?

Connectez-vous à votre espace client, générez votre clé API et commencez votre intégration.

Accéder à l’espace client Contacter le support

Consultez également nos CGV.