---
sourceDocument: Interfaces conversationnelles Yokohama
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/fr-FR/yokohama/conversational-interfaces

 Release :

    - yokohama

ft:locale :

    - fr-FR

ft:publication_title :

    - Interfaces conversationnelles Yokohama

ft:clusterId :

    - convint

bundleId :

    - convint

workflow :

    - Platform


---

# Créez et configurez une API REST scriptée pour votre intégration de messagerie instantanée personnalisée

# Créez et configurez une API REST scriptée pour votre intégration de messagerie instantanée personnalisée {#ariaid-title1}

* Rversion finale: Yokohama
* 
* Mis à jour 30 janv. 2025
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 3 minutes de lecture

Créez une API REST scriptée, ajoutez une ressource REST scriptée, définissez la sécurité et la négociation de contenu, et définissez des limites de débit d'API REST.

## Avant de commencer

[Mapper les contrôles enrichis au canal dans votre intégration de messagerie instantanée personnalisée](https://servicenow-prod.fluidtopics.net/vbIsNJ3FVxuTGWDOQw0wUw "Créez des enregistrements pour les contrôles enrichis dans la table Configurations d’adaptateur personnalisé [sys_cs_custom_adapter_config]. Si un contrôle enrichi n’a pas d’implémentation de transformateur sortant, l’utilisateur final n’a pas reçu de réponse et l’expérience de messagerie instantanée peut ne pas être satisfaisante.").

Rôle requis : admin

## Procédure

1. Créez l'API REST.
   1. Accédez à TousServices web du systèmeServices Web basés sur un scriptAPI REST basées sur un script.
   2. Cliquez sur Nouveau.
   3. Sur le formulaire, renseignez les champs.  
      {#configure-rest-api-va-cccif__table_syk_xhl_1mb__entry__2}

      | Champ | Description |
      |-|-|
      | Nom | Nom de votre API. Par exemple, <kbd class="ph userinput">ACME Mobile App Chat Adapter</kbd>. |
      | ID API | Identificateur d'API. Par exemple, <kbd class="ph userinput">acme_chat</kbd>. |
      | Politique de protection | Politique de protection du script. * Lecture seule : le script est visible uniquement. * Protégé : les utilisateurs disposant d'autorisations de mot de passe peuvent modifier le script. {#configure-rest-api-va-cccif__ul_jmv_hgx_ktb} |
      | Application | Application contenant l'enregistrement de script. Global est sélectionné par défaut. |
      | Espace de noms de l'API | Espace de noms auquel l'API appartient. La valeur dépend du périmètre de l'application actuel. |
      [ ]

      {#configure-rest-api-va-cccif__table_syk_xhl_1mb}
   4. Cliquez sur Envoyer.
   5. **Facultatif :** Ouvrez le nouvel enregistrement, accédez aux liens connexes et cliquez sur Activer la gestion des versions, puis cliquez sur OK.  
      Cliquez sur Mettre à jour pour enregistrer vos modifications.
   {#configure-rest-api-va-cccif__substeps_bfp_gc5_wlb}
2. Ajoutez une ressource REST scriptée à votre nouvelle API REST.  
   La ressource REST scriptée définit la définition de l'API REST scriptée que vous avez créée.
   1. Ouvrez l'enregistrement d'API REST que vous avez créé, puis accédez à l'onglet Ressources sous Liens connexes.
   2. Cliquez sur Nouveau.  
      Récupérez la charge utile à partir de la demande, puis écrivez-la dans une file d'attente hybride.
   3. Remplissez les champs du formulaire.  
      {#configure-rest-api-va-cccif__table_dyh_d3l_1mb__entry__2}

      | Champ | Description |
      |-|-|
      | Définition de l'API | Nom de l'API parente. |
      | Application | Application contenant l'enregistrement de script. |
      | Nom | Nom de votre ressource REST d'API. Par exemple, la messagerie instantanée ACME. |
      | Version d'API | Version de l'API. Par exemple, v1. Ce champ s'affiche uniquement si vous avez activé la gestion des versions pour l'API REST. |
      | Actives | Option pour rendre la ressource REST active. |
      | Méthode HTTP | Méthode HTTP, telle que POST, GET, etc. |
      | Chemin d'accès relatif | Chemin d'accès relatif à la ressource. |
      | Script | Script pour la ressource REST. |
      | Politique de protection | Politique de protection du script. * Lecture seule : le script est visible uniquement. * Protégé : les utilisateurs disposant d'autorisations de mot de passe peuvent modifier le script. {#configure-rest-api-va-cccif__ul_kh4_13x_ktb} |
      [ ]

      {#configure-rest-api-va-cccif__table_dyh_d3l_1mb}  
      Exemple d'une ressource REST scriptée :

          (function process(/*RESTAPIRequest*/ request, /*RESTAPIResponse*/ response) {
              var body = request.body;
              var queryParams = request.queryParams; // incoming content is application/x-www-form-urlencoded in this example    
              // get the provider application sys id. this can be done via a glide query using incoming data such as where the original message is being sent to. or it can be hard-coded such as this example.
              var providerAppId = "a5f8b75b7377001042281188caf6a73a";    
              // the time of receipt is recorded for analytics purposes
              var d = new Date();
              var logTime = d.getTime();    
              // add this message to the VA Server queue for processing
              var queued = sn_cs.VASystemObject.enqueueCustomAdapterMessage(providerAppId, JSON.stringify(queryParams), JSON.stringify(request.headers), logTime);
              if (queued == false) {
          	response.setError(new sn_ws_err.BadRequestError('Failed to process the request.'));
              }
          })(request, response);
          ​

   {#configure-rest-api-va-cccif__substeps_mp5_xkp_xlb}
3. Définissez la sécurité et la négociation du contenu pour votre ressource REST scriptée.  
   Choisissez de définir les formats d'authentification et de demande. Si votre intégration personnalisée ne repose pas sur l'authentification, vous pouvez la supprimer comme suit.
   1. Dans le nouvel enregistrement de la ressource REST scriptée, accédez à l'onglet Sécurité .
   2. Effacer Requiert une authentification.
   3. Cliquez sur l'onglet Négociation de contenu , puis sélectionnez Remplacer les formats de demande pris en charge.
   4. Cliquez sur Envoyer.
   {#configure-rest-api-va-cccif__substeps_es1_v2h_zlb}
4. Définissez des limites de débit de l'API REST pour définir le taux de demandes entrantes.
   1. Accédez à TousServices web du systèmeRESTRègles de limites de taux.
   2. Cliquez sur Nouveau.
   3. Sur le formulaire, renseignez les champs.  
      {#configure-rest-api-va-cccif__table_jk5_vdy_ktb__entry__2}

      | Champ | Description |
      |-|-|
      | Nom | Nom unique de la règle de limite de taux. |
      | REST API | API REST que vous avez créée à une étape précédente. |
      | Version | Version de l'API REST. Les valeurs répertoriées dépendent de l'API REST sélectionnée. |
      | Ressource | Ressource pour la version spécifiée. Les valeurs répertoriées dépendent de la version sélectionnée. |
      | Actives | Case à cocher indiquant que la règle de limite de taux est active. Les règles de limite de taux sont activées par défaut dès que vous les créez. Vous pouvez désactiver les règles de limite de taux pour arrêter l'application d'une limite de taux ou activer les règles de limite de taux pour reprendre l'application d'une limite de taux. |
      | Limite de demandes par heure | Nombre maximal de demandes autorisées par heure. Remarque : Chaque fois que vous mettez à jour la valeur de ce champ, réinitialise Now Platform le nombre de demandes à 0 et supprime toutes les violations pour l'heure en cours. |
      | Appliquer à | Utilisateurs restreints par cette règle. Sélectionnez Tous les utilisateurs. |
      [ ]

      {#configure-rest-api-va-cccif__table_jk5_vdy_ktb}
   4. Cliquez sur Envoyer.
   {#configure-rest-api-va-cccif__substeps_q3r_cyx_ktb}

## Que faire ensuite

[Créer les scripts d'action pour votre intégration de messagerie instantanée personnalisée](https://servicenow-prod.fluidtopics.net/p6h3rTtzy7r6fkDg5uikCw "Configurez les transformations que votre intégration de messagerie instantanée personnalisée doit communiquer via le processus de messagerie instantanée.")