fr
Fintech

Documentation API

Le site client, le back office et tous les modules de la plateforme fonctionnent avec les fichiers de base de données via l'API, et non directement. L'API contrôle l'accès, l'intégrité et l'exactitude des données entrantes.

Description générale

Comment fonctionne l'API ?

API - le nœud clé de la plateforme

Cette documentation décrit toutes les méthodes d'API pour les actions suivantes :

  • obtenir des listes d'objets (méthode list)
  • filtrage de liste (méthode de liste avec données de filtre)
  • obtenir des informations détaillées sur un objet (méthode show)
  • obtenir des données pour le formulaire d'ajout d'objet (méthode add)
  • enregistrement des données en tant que nouvel objet (méthode store)
  • obtenir des données pour le formulaire de mise à jour d'objet (méthode d'édition)
  • enregistrer les données de l'objet mis à jour (méthode de mise à jour)

Vérification par adresse IP

L'API n'accepte que les demandes provenant d'une liste limitée d'adresses IP (par exemple, du site de compte d'un client ou d'un site de back-office).

Toute demande à l'API à partir d'une adresse IP qui n'est pas sur la liste autorisée sera rejetée.

Ceci est fait pour empêcher les attaques DDoS sur l'API, les tentatives de falsification des demandes et les expériences de piratage.

Les utilisateurs accèdent toujours au site public de la plateforme (bureau du client ou back office), et ce site lui-même demande les données nécessaires à l'API de la plateforme. L'adresse IP du site étant fixe, elle figurera sur la liste autorisée.

URL et méthode

Toutes les requêtes API sont effectuées à l'aide des méthodes HTTP suivantes :

  • GET pour lister, afficher, ajouter et modifier
  • POST pour magasin
  • PUT pour la mise à jour
  • DELETE pour supprimer

Chaque section de l'API contient une URL à laquelle une demande est faite pour obtenir les données pertinentes.

La méthode de requête HTTP est spécifiée devant chaque URL.

Envoi d'une demande

Chaque requête API doit toujours contenir 4 variables :

  1. data (chaîne json avec tableau de données pour l'API)
  2. user (chaîne json avec un tableau de données sur l'utilisateur actuel)
  3. time (heure actuelle dans le fuseau horaire UTC)
  4. hash (signature numérique sous forme de hash pour vérifier que la requête à l'API provient bien d'une source autorisée)

Obtenir une réponse de l'API

Si la requête aboutit, l'API renvoie toujours deux variables :

  1. status = true (statut de réussite)
  2. data (chaîne json avec tableau de données de l'API)

Si la requête échoue, l'API affiche les variables :

  1. status = false (état d'erreur)
  2. error (chaîne de texte décrivant l'erreur)

Signature numérique

Chaque requête API doit contenir une variable de hachage qui est la signature numérique de la requête.

hash = md5($json . $time . $salt)

  • md5, sha256, bcrypt — algorithmes de chiffrement disponibles
  • $json — chaîne json avec les données de la requête
  • $time — heure au format "JJ.MM.AAAA HH:MM:SS"
  • $salt — valeur unique fixe ("salt") pour l'API de la plate-forme

Fintech

La documentation contient des exemples de requêtes API réelles