DocumentationREST API · OpenAPI 3.1
Référence API
Base URL : https://api.score360.africa/v1
Authentification : header Authorization: Bearer {sk_live_...} sur tous les endpoints.
Endpoints
Points d'entrée de l'API
POST
/v1/score— Calculer un score PMERetourne le score (0–900), le grade (A–E), la confiance, le trend et les facteurs explicatifs pour une entité PME donnée.
| Paramètre | Type | Requis | Description |
|---|---|---|---|
entity_id | string | oui | Identifiant unique de la PME |
flow_window | integer | non | Fenêtre d'analyse en jours (défaut: 90) |
sector | string | non | Secteur d'activité (commerce, agri, santé…) |
GET
/v1/score/:entity_id— Récupérer le score actuelRetourne le score en cache sans recalcul. Plus rapide — adapté aux affichages dashboards.
| Paramètre | Type | Requis | Description |
|---|---|---|---|
entity_id | string | oui | Identifiant unique de la PME (path param) |
GET
/v1/score/:entity_id/history— Historique des scoresRetourne l'historique des scores sur une période donnée, avec le trend et les alertes associées.
| Paramètre | Type | Requis | Description |
|---|---|---|---|
entity_id | string | oui | Identifiant unique de la PME |
from | ISO 8601 | non | Date de début |
to | ISO 8601 | non | Date de fin (défaut: aujourd'hui) |
POST
/v1/webhooks— Créer un webhookEnregistre un endpoint HTTPS pour recevoir des événements SCORE360 (score.updated, alert.npl_risk…).
| Paramètre | Type | Requis | Description |
|---|---|---|---|
url | string | oui | URL HTTPS de réception |
events | string[] | oui | Liste des événements à écouter |
secret | string | non | Secret de signature HMAC-SHA256 |
GET
/v1/entities— Lister les entitésRetourne la liste paginée des PME enregistrées sur votre compte, avec leur score et grade actuels.
| Paramètre | Type | Requis | Description |
|---|---|---|---|
page | integer | non | Numéro de page (défaut: 1) |
limit | integer | non | Résultats par page (défaut: 50, max: 200) |
grade | string | non | Filtrer par grade (A, B, C, D, E) |
Codes d'erreur
Gestion des erreurs
Toutes les erreurs retournent un JSON avec un champ `error` (code machine) et un champ `message` (lisible).
400bad_requestCorps de requête invalide ou paramètre manquant.401unauthorizedClé API manquante ou invalide.403forbiddenAccès refusé — vérifiez les permissions RBAC.404entity_not_foundEntité PME introuvable.429rate_limitedQuota d'appels dépassé. Relancez après le délai indiqué dans Retry-After.500internal_errorErreur serveur interne. Contactez dev@score360.africa.