Concepts API

Cette section explique les concepts techniques fondamentaux et les conventions utilisés dans toutes les APIs YAPU. Si vous débutez avec l'intégration YAPU, lisez cette page avant de passer à l'authentification ou aux spécifications techniques.

Vue d'ensemble de l'architecture

Les APIs YAPU suivent l'architecture REST (Representational State Transfer). Cela signifie :

• Les APIs sont organisées autour de ressources et accessibles via des verbes HTTP standard (GET, POST, etc.)
• Chaque requête et réponse utilise JSON comme format de données
• Toutes les communications se font via HTTPS — sans exception
• Chaque appel API est une requête JSON unique, ni groupée ni en streaming

Cela rend les APIs YAPU compatibles avec tout langage de programmation ou plateforme moderne capable d'effectuer des requêtes HTTPS et d'analyser du JSON.

Exigences de transport et de sécurité

HTTPS uniquement

Toutes les communications avec les APIs YAPU doivent se faire via HTTPS. Les requêtes envoyées en HTTP simple ne seront pas acceptées. Cette exigence n'admet aucune exception.

Communication IP dynamique

YAPU prend en charge la communication IP dynamique. L'adresse IP de votre intégration n'a pas besoin d'être enregistrée ou inscrite sur liste blanche à l'avance.

:::warning Limitation importante YAPU ne prend pas en charge la communication IP statique. Si votre infrastructure requiert une adresse IP fixe et inscrite sur liste blanche pour accéder à des services externes, ce point doit être discuté avec votre contact YAPU avant le début de la phase de spécification. :::

Format des requêtes et réponses

Structure des requêtes

Chaque appel API YAPU est effectué sous la forme d'une requête JSON unique. Il n'y a pas de requêtes multipart ni d'envois de fichiers dans les offres API standard.

Les requêtes suivent les conventions HTTPS standard :

• Un verbe HTTP défini (p. ex. POST, GET)
• Des en-têtes de requête obligatoires, incluant l'authentification
• Un corps JSON le cas échéant

Les structures exactes des requêtes sont définies pour chaque offre API dans la documentation technique fournie lors de la phase de spécification.

Structure des réponses

YAPU retourne les réponses en JSON. Les données de réponse sont généralement fournies sous forme de valeurs de type chaîne (string) — il incombe au client de convertir ces chaînes dans les types de données appropriés pour ses propres systèmes.

remarque

La conversion des données sortantes YAPU du format chaîne vers votre propre modèle de données est une responsabilité cliente qui doit être intégrée dans le périmètre de votre développement.

Codes de statut HTTP

Les APIs YAPU utilisent des codes de statut HTTP standard pour communiquer le résultat d'une requête :

Code	Signification
200 OK	Requête réussie
201 Created	Ressource créée avec succès
400 Bad Request	Requête mal formée ou champs obligatoires manquants
401 Unauthorized	Échec d'authentification ou token manquant
403 Forbidden	Authentifié mais non autorisé pour cette action
404 Not Found	La ressource n'existe pas
422 Unprocessable Entity	Requête valide mais ne pouvant pas être traitée
500 Internal Server Error	Erreur inattendue côté YAPU

Conventions de format des données

Données entrantes (client vers YAPU)

Les données envoyées de votre système vers YAPU doivent respecter les formats spécifiques YAPU. Ces formats sont définis pour chaque offre API dans la documentation technique fournie lors de la phase de spécification.

Le non-respect du format correct entraîne l'échec de la requête. YAPU ne transforme pas silencieusement ni ne reformate les données entrantes.

Données sortantes (YAPU vers client)

Les données retournées par YAPU sont fournies sous forme de valeurs de type chaîne (string). Votre système est responsable de l'interprétation et de la conversion de ces données dans les formats requis par votre application.

Environnements

YAPU fournit deux environnements pour l'intégration :

Environnement	Objectif
Staging	Développement et tests d'intégration — non destiné à la production
Production	Système live — utilisé uniquement après des tests mutuels réussis en staging

Les URLs et identifiants propres à chaque environnement sont fournis par votre contact YAPU lors de la phase de spécification et ne sont pas publiés dans ce portail.

info

Effectuez toujours les tests en staging avant de déployer en production. Consultez Tests et mise en production pour le processus de test complet.

Récapitulatif

Concept	Valeur
Architecture	REST
Format des données	JSON
Transport	HTTPS uniquement
Communication IP	Dynamique (IP statique non prise en charge)
Type de requête	Requête JSON unique par appel
Type des données sortantes	Chaîne (conversion côté client)
Format des données entrantes	Spécifique YAPU (défini par offre)
Codes de statut HTTP	Standard