Créer une ressource d’API REST scriptée

  • Rversion finale: Yokohama
  • Mis à jour 30 janv. 2025
  • 1 minute de lecture
  • Créez une ressource d’API REST scriptée pour définir la méthode HTTP et le script de traitement et pour remplacer les paramètres du service parent.

    Avant de commencer

    Une API REST scriptée doit être définie avant de pouvoir créer des ressources.

    Rôle requis : web_service_admin

    Pourquoi et quand exécuter cette tâche

    Par défaut, toute nouvelle ressource d’API REST scriptée que vous créez contient une ACL qui interdit aux utilisateurs disposant du rôle snc_external d’effectuer des demandes à l’API.

    Procédure

    1. Accédez à la Tout > Services web du système > API REST basées sur un script.
    2. Sélectionnez un enregistrement scripté de l’API REST.
    3. Dans la liste connexe Ressources , cliquez sur Nouveau.
    4. Saisissez un Nom.
      Le nom de la ressource affecte l’URI d’envoi des demandes à l’API.
    5. Sélectionnez la méthode HTTP que cette ressource implémente, par exemple GET.
    6. Dans le champ Script , définissez la manière dont l’opération analyse les demandes et y répond.
    7. Facultatif : Remplacez les paramètres de l’API REST parent selon vos besoins, par exemple en spécifiant des paramètres de sécurité différents ou des types de contenu valides.
    8. Facultatif : Dans l’onglet Documentation , fournissez une brève description expliquant comment accéder à la ressource.
      Ces informations s’affichent lors de l’exploration de cette ressource à l’aide de l’explorateur d’API REST.
    9. Cliquez sur Envoyer.

    Que faire ensuite

    Après avoir créé la ressource, vous pouvez associer des en-têtes et des paramètres de requête. Pour plus d’informations, consultez Définir les en-têtes d’API REST scriptés et Définir les paramètres de requête disponibles.