Référence API

À quoi sert cette page#

Utilisez cette page comme manuel destiné à la machine pour la surface UAIX REST en direct. Il traduit le catalogue actuel, la découverte, la feuille de route, le schéma, le registre, l'exemple, le validateur, le kit d'adoption, OpenAPI, les itinéraires d'échange simulé et de pack de conformité en une référence de lancement lisible par l'homme.

Quand l'utiliser#

• Lorsqu'un implémenteur souhaite connaître le chemin de base et l'inventaire des routes exacts non régionaux REST.
• Lorsqu'un créateur d'outils a besoin de demandes de démarrage, du bundle d'adoption, des limites du plan prévisionnel et d'un document OpenAPI au lieu de procéder à une ingénierie inverse du site.
• Lorsqu'un examinateur de lancement souhaite vérifier que la documentation publique, les itinéraires destinés aux machines, les limites de la feuille de route et les preuves du validateur pointent tous vers la même version.

Itinéraire le plus rapide à travers la surface vivante#

1. Résoudre le courant/wp-json/uaix/v1/catalogitinéraire en premier.
2. Récupérer un schéma ou un exemple à partir deSchémas, Registre, etExemples.
3. Tirez le publiéKit d'adoptionlorsque vous avez besoin du paquet d'intégration réutilisable le plus court.
4. Soumettre un validateurValidateurou le face machine/wp-json/uaix/v1/validateitinéraire.
5. Utilisez lePaquet de conformitélorsque cette course doit voyager en tant que preuve de diffusion plus large.
6. Utiliser/wp-json/uaix/v1/roadmaplorsque l’automatisation a également besoin des limites actuelles des travaux futurs.

Carte des classes d'itinéraire#

• Itinéraires de découverte GET:Le catalogue, la découverte, les schémas, le registre, le registre de champs, les exemples, les liaisons de transport, les canaux de confiance, le registre des erreurs, les niveaux de conformité, la feuille de route, OpenAPI, le kit d'adoption et les itinéraires des packs de conformité publient les enregistrements actuels lisibles par machine.
• Exécution des routes POST:Les routes de validation et d'échange simulé acceptent le candidat JSON et doivent être traitées comme des surfaces d'exécution sans magasin, et non comme des pages de destination explorables.
• Itinéraires de citation humaine:Les pages préfixées par les paramètres régionaux telles que UAI-1, Validator, Adoption Kit, Conformance Pack, Roadmap et Changelog sont les pages qu'une revendication publique doit citer lorsque la prose, les limites et les prochaines étapes sont importantes.
• Télécharger les formulaires:Les paquets JSON téléchargeables sont des formulaires pratiques des mêmes archives publiques, et non des autorités distinctes.

Ce que publie cette page#

• Une référence route par route orientée machine.
• Exemples de requêtes de démarrage pour la découverte, la recherche de profil, la validation, la récupération du bundle d'intégration et la résolution de la feuille de route.
• Exportation OpenAPI 3.1 actuelle pour la surface REST en direct.
• Liens directs vers les pages publiques canoniques qui expliquent le même enregistrement en prose.

Appels de démarrage au niveau de la route#

Utilisez les extraits publics ci-dessous lorsque vous souhaitez que le catalogue en direct, l'exemple et les appels du validateur dans curl, PowerShell, Python ou TypeScript sans procéder à une ingénierie inverse de la surface de routage.

curl -sS /wp-json/uaix/v1/catalog

const catalog = await fetch('/wp-json/uaix/v1/catalog').then((response) => response.json());

$catalog = json_decode(file_get_contents('/wp-json/uaix/v1/catalog'), true, 512, JSON_THROW_ON_ERROR);

catalog = requests.get('/wp-json/uaix/v1/catalog', timeout=10).json()

Référence en direct face à la machine#

Utilisez la référence ci-dessous comme source publique actuelle pour la configuration des itinéraires, les appels de démarrage et l'exportation OpenAPI.

Étape suivante#

Continuez àKit d'adoptionsi vous avez besoin du bundle de première épreuve publié,Paquet de conformitési vous avez besoin du paquet JSON réutilisable plus large, ouvrez/wp-json/uaix/v1/roadmapsi l'automatisation a besoin de la limite du travail futur, ou revenir àValidateurlorsque la tâche suivante est en cours d'exécution ou lors de l'exportation d'une vérification concrète.