Documentation · Documentation développeur

API REST pour les développeurs

Cette page ne liste volontairement pas les routes REST internes, les paramètres, les contrôleurs, les nonces ou les charges utiles de réponse.

Pourquoi aucun contrat REST public

L'extension expose un petit nombre de points de terminaison REST pour prendre en charge sa propre administration, son importateur et son JavaScript frontal. Ces points de terminaison sont internes — ils existent pour faire fonctionner l'extension, et non pour fournir une API d'intégration publique. Les noms de routes, les paramètres et les réponses peuvent changer d'une version à l'autre sans préavis.

Si vous devez intégrer un système externe à l'extension, n'appelez pas ces points de terminaison internes. Utilisez plutôt les surfaces d'intégration prises en charge répertoriées ci-dessous, ou ouvrez une demande de fonctionnalité décrivant l'intégration dont vous avez besoin.

Surfaces d'intégration publiques prises en charge

Lors de l'intégration avec l'extension, privilégiez ces surfaces stables :

Les noms de classes internes, les clés d'option, les tables de base de données, les points de terminaison REST et AJAX, les noms de hooks cron, les identifiants de capacités et de nonces, ainsi que l'infrastructure de publication / mise à jour sont traités comme des détails d'implémentation. Ils peuvent changer d'une version à l'autre sans préavis et ne font pas partie du contrat d'intégration public.

Politique de stabilité et de changement

Tout ce qui n'est pas répertorié comme une surface publique prise en charge ci-dessus est considéré comme un détail d'implémentation interne. Les API internes, la structure de stockage et l'implémentation de la sécurité peuvent changer d'une version à l'autre. Ne dépendez pas d'eux à partir de codes tiers, de thèmes ou de systèmes externes. Les écritures directes dans la base de données ne sont pas prises en charge.

Avis de documentation publique. Cette page fournit uniquement un aperçu de haut niveau de l'intégration. Les détails d'implémentation interne, les API privées, les aspects internes du stockage et l'infrastructure de publication sensible à la sécurité sont gérés séparément et ne font pas partie de la documentation publique. Les surfaces d'intégration prises en charge sont les shortcodes documentés, les surcharges de modèles, l'interface utilisateur des réglages et tous les points d'extension explicitement publiés dans cette section.