diff --git a/en/automation/automation-cloudops-api.md b/en/automation/automation-cloudops-api.md index 8662482..0bc32a6 100644 --- a/en/automation/automation-cloudops-api.md +++ b/en/automation/automation-cloudops-api.md @@ -1,6 +1,6 @@ --- title: "Automating tasks with the CloudOps API" -slug: cloudops-api +slug: automating-tasks-with-api --- @@ -23,7 +23,7 @@ The articles in the Automation category provide a starting point for users who h ## What to expect -To make this guide accessible to the widest audience, the examples presented in these articles use an industry-standard utility called cURL. This program is included on all macOS, Linux, and Windows systems. It is a command that can be pasted into a terminal window for macOS and Linux users, or into a command prompt or PowerShell window for Windows users. When the cURL command is run, it will connect to the CloudOps API using your user account, send your API call as request to the CloudOps system, and then it will print out the response that CloudOps returned. +To make this guide accessible to the widest audience, the examples presented in these articles use an industry-standard utility called cURL. This program is included on all macOS, Linux, and Windows systems. It is a command that can be pasted into a terminal window for macOS and Linux users, or into a command prompt or PowerShell window for Windows users. When the cURL command is run, it will connect to the CloudOps API using your user account, send your API call to the CloudOps system, and then it will print out the response that CloudOps returned. The cURL command presented with each example is meant to be copied from the article and pasted into a text editor. In the text editor, you can replace text within the braces with the required values, and then paste the modified command into you terminal or command prompt. For example, a cURL command to list all environments you have access to with your user account might look like this: @@ -49,7 +49,7 @@ For a detailed example on parsing the JSON data, see the [Get knowledge base ID] Windows users, please note that you will have to edit the examples before they can be used, due to how Windows treats special characters. - If you are using a **command prompt** \(`cmd.exe`\) window: Replace the backslash with a carat symbol \('`^`'\) -- If you are using a **PowerShell** window: Replace the backslash with a space and a backtick symbol \('```\) +- If you are using a **PowerShell** window: Replace the backslash with a space and a backtick symbol \('`` ` ``'\) **Attention:** In both cases, the carat or the backtick must be the last character on the line. diff --git a/es/automation/automation-cloudops-api.md b/es/automation/automation-cloudops-api.md index e9e5fcf..ce3cf9e 100644 --- a/es/automation/automation-cloudops-api.md +++ b/es/automation/automation-cloudops-api.md @@ -7,25 +7,25 @@ slug: automatizar-tares-con-la-api Este artículo es una introducción para principiantes a la API REST de CloudOps y proporciona detalles sobre cómo acceder a ella, además de crear contexto para los demás artículos de la categoría Automatización. -## Resumen <--Here +## Resumen -Para ciertas tareas sencillas, puede resultarte útil ejecutarlas sin tener que iniciar sesión en la interfaz de usuario web de CloudOps. Por ejemplo, puede que necesite repetidamente: +Para ciertas tareas sencillas, puede resultarte útil ejecutarlas sin tener que iniciar sesión en la interfaz de usuario web de CloudOps. Por ejemplo, puede que necesites repetidamente: - Sincronizar la base de conocimientos después de realizar cambios en el contenido - Generar un informe mensual con los mismos criterios y filtros - Añadir nuevos usuarios como miembros a un entorno específico -En estos casos, ejecutar una sola llamada a la API sin tener que iniciar sesión en la interfaz web puede ahorrarle tiempo y esfuerzo. Además, puede usar cualquier herramienta de programación para activar sus llamadas a la API automáticamente cuando lo desee. +En estos casos, ejecutar una sola llamada a la API sin tener que iniciar sesión en la interfaz web puede ahorrarle tiempo y esfuerzo. Además, puedes usar cualquier herramienta de programación para activar tus llamadas a la API automáticamente cuando lo desees. -Como plataforma de orquestación basada en API, CloudOps proporciona acceso a toda la funcionalidad a través de su API REST. Cualquier función accesible a través de la interfaz web también se puede acceder a través de la API. Todas las llamadas a la API están protegidas mediante conexiones HTTPS y una clave de API única para su cuenta. +Como plataforma de orquestación basada en API, CloudOps proporciona acceso a toda la funcionalidad a través de su API REST. Cualquier función accesible a través de la interfaz web también se puede acceder a través de la API. Todas las llamadas a la API están protegidas mediante conexiones HTTPS y una clave de API única para tu cuenta. -Los artículos de la categoría Automatización ofrecen un punto de partida para usuarios con poca o ninguna experiencia previa con herramientas API. No pretenden reemplazar la documentación completa de la API. Se trata de una guía intuitiva y sencilla para usar la API, con numerosos ejemplos, que evita la instalación de software. Cada ejemplo puede modificarse para adaptarlo a su situación particular e incluso utilizarse en conjunto para crear flujos de trabajo automatizados. +Los artículos de la categoría Automatización ofrecen un punto de partida para usuarios con poca o ninguna experiencia previa con herramientas API. No pretenden reemplazar la documentación completa de la API. Se trata de una guía intuitiva y sencilla para usar la API, con numerosos ejemplos, que evita la instalación de software. Cada ejemplo puede modificarse para adaptarlo a tu situación particular e incluso utilizarse en conjunto para crear flujos de trabajo automatizados. -## What to expect +## Qué anticipar -To make this guide accessible to the widest audience, the examples presented in these articles use an industry-standard utility called cURL. This program is included on all macOS, Linux, and Windows systems. It is a command that can be pasted into a terminal window for macOS and Linux users, or into a command prompt or PowerShell window for Windows users. When the cURL command is run, it will connect to the CloudOps API using your user account, send your API call as request to the CloudOps system, and then it will print out the response that CloudOps returned. +Para que esta guía sea accesible al público más amplio, los ejemplos presentados en estos artículos utilizan una utilidad estándar llamada cURL. Este programa está incluido en todos los sistemas macOS, Linux y Windows. Es un comando que se puede pegar en una ventana de terminal para usuarios de macOS y Linux, o en un símbolo del sistema o una ventana de PowerShell para usuarios de Windows. Al ejecutar el comando cURL, se conectará a la API de CloudOps usando tu cuenta de usuario, enviará la llamada API al sistema CloudOps y, a continuación, imprimirá la respuesta devuelta por CloudOps. -The cURL command presented with each example is meant to be copied from the article and pasted into a text editor. In the text editor, you can replace text within the braces with the required values, and then paste the modified command into you terminal or command prompt. For example, a cURL command to list all environments you have access to with your user account might look like this: +El comando cURL que se presenta en cada ejemplo debe copiarse del artículo y pegarse en un editor de texto. En el editor de texto, puedes reemplazar el texto entre llaves con los valores necesarios y luego pegar el comando modificado en tu terminal o símbolo del sistema. Por ejemplo, un comando cURL para listar todos los entornos a los que tienes acceso con tu cuenta de usuario podría tener este aspecto: ``` curl --request GET \ @@ -34,42 +34,42 @@ curl --request GET \ --header 'MC-Api-Key: {api-key}' ``` -To prepare this example for execution, you will copy the full text from the article and paste it into a text editor. For readability, the cURL command is broken into multiple lines using the backslash \('`\`'\) symbol to force a line-wrap. \(Windows users please be sure to read the Windows users only section, because you will need to use a different symbol to accomplish this.\) Notice that there are two markers, which act as placeholders for the data you will supply: `{endpoint-url}`, and `{api-key}`. You will replace these markers \(including the surrounding braces\) with the relevant values, as explained in the API key and API endpoint sections. +Para preparar este ejemplo para su ejecución, copiarás el texto completo del artículo y lo pegarás en un editor de texto. Para facilitar la lectura, el comando cURL se divide en varias líneas mediante la barra invertida \('`\`'\) para forzar un ajuste de línea. (Los usuarios de Windows, lee la sección para solamente los usuarios de Windows, ya que necesitarás usar un símbolo diferente para lograr esto). Observa que hay dos marcadores que actúan como marcadores de posición para los datos que proporcionarás: `{endpoint-url}` y `{api-key}`. Reemplace estos marcadores (incluidas las llaves) con los valores correspondientes, como se explica en las secciones "Clave API" y "Punto de conexión de API". -When working with any API, there is always going to be some technical aspect to the functionality. However, when executing simple tasks, many details can be safely ignored. For example, when you execute your API task \(often referred to as "making an API call"\), the system will return a response which will contain a lot of text. This text will be in a standard format called JSON. +Al trabajar con cualquier API, siempre habrá algún aspecto técnico en su funcionalidad. Sin embargo, al ejecutar tareas sencillas, muchos detalles pueden ignorarse sin problemas. Por ejemplo, al ejecutar una tarea de API (a menudo denominada "hacer una llamada a la API"), el sistema devolverá una respuesta con mucho texto. Este texto estará en un formato estándar llamado JSON. -This wall of text may seem daunting and unrecognizable. There will be a lot of symbols, such as brackets and parentheses. Although these symbols are important because they help to structure the response, but luckily they can be ignored for the most part, because they are not the data you need. Particularly if you are simply executing an operation, all you might be looking for is a value that says `OK`, to indicate that the operation succeeded. +Este bloque de texto puede parecer abrumador e irreconocible. Contendrá muchos símbolos, como corchetes y paréntesis. Aunque estos símbolos son importantes porque ayudan a estructurar la respuesta, afortunadamente se pueden ignorar en su mayor parte, ya que no son los datos que necesitas. Sobre todo si simplemente estás ejecutando una operación, es posible que solo busques un valor que indique "OK" para verificar que la operación se realizó correctamente. -Similarly, the response may contain a lot of extraneous data. For example, the API call above returns many fields with values. It is not just a list of environments, it includes parameters about each listed environment. To identify each environment, you will have to inspect the response to find the value you need. This is where it becomes important to take the response, put it into a text editing tool, and use the Find feature to locate the target date. For more complex responses with a large amount of data, you may wish to use a text editor which can reformat a JSON document to make the response more human-readable. +De igual forma, la respuesta puede contener muchos datos superfluos. Por ejemplo, la llamada a la API anterior devuelve muchos campos con valores. No se trata simplemente de una lista de entornos, sino que incluye parámetros sobre cada uno de ellos. Para identificar cada entorno, deberás inspeccionar la respuesta y encontrar el valor necesario. Aquí es donde resulta importante tomar la respuesta, introducirla en un editor de texto y usar la función Buscar para localizar la fecha objetivo. Para respuestas más complejas con una gran cantidad de datos, se puede utilizar un editor de texto que pueda reformatear un documento JSON para que la respuesta sea más legible. -For a detailed example on parsing the JSON data, see the [Get knowledge base ID](automation-get-knowledge-base.md) article. +Para obtener un ejemplo detallado sobre cómo analizar datos JSON, consulta el artículo [Obtener ID de la base de conocimientos](automation-get-knowledge-base.md). -## Windows users only +## Sólo usuarios de Windows -Windows users, please note that you will have to edit the examples before they can be used, due to how Windows treats special characters. +Usuarios de Windows, tengan en cuenta que deberán editar los ejemplos antes de poder usarlos, debido a la forma en que Windows trata los caracteres especiales. -- If you are using a **command prompt** \(`cmd.exe`\) window: Replace the backslash with a carat symbol \('`^`'\) -- If you are using a **PowerShell** window: Replace the backslash with a space and a backtick symbol \('```\) +- Si estás utilizando una **ventana de símbolo del sistema** \(`cmd.exe`\): reemplaza la barra invertida con un símbolo de acento circunflejo \('`^`'\) +- Si estás utilizando una ventana de **PowerShell**: reemplaza la barra invertida con un espacio y un símbolo de tilde invertida \('`` ` ``'\) -**Attention:** In both cases, the carat or the backtick must be the last character on the line. +**Atención:** En ambos casos, el símbolo de acento circunflejo o la tilde invertida debe ser el último carácter de la línea. -## API key +## Clave API -In order to use the CloudOps API, you will start by logging into the system and creating an API key for your requests. The API key acts as the credentials that cURL will send to CloudOps to authenticate itself using your user account. +Para usar la API de CloudOps, inicia sesión en el sistema y crea una clave API para tus solicitudes. Esta clave actúa como las credenciales que cURL enviará a CloudOps para autenticarse con tu cuenta de usuario. -The following article provides the steps on creating a new API key: +El siguiente artículo describe los pasos para crear una nueva clave API: -- [Generate a CloudOps API key](../how-to/how-to-cloudmc-api-key.md) +- [Generar una clave API de CloudOps](../how-to/how-to-cloudmc-api-key.md) -Once you have generated your API key, store it in a safe place, because the system will never display it to you again. Use your API key to replace the `{api-key}` marker in the example cURL commands. +Una vez generada la clave API, guárdala en un lugar seguro, ya que el sistema no la volverá a mostrar. Úsala para reemplazar el marcador `{api-key}` en los comandos cURL de ejemplo. -## API endpoint +## Punto de conexión de la API -In addition to the API keys, the API credentials section of the User Settings panel will also list the URL to use when connecting to an endpoint. See the [API Credentials](api-credentials.md) article for full details. +Además de las claves API, la sección de credenciales de la API del panel Parámetros de usuario también mostrará la URL que se debe usar para conectarse a un punto de conexión. Consulta el artículo [Credenciales de la API](api-credentials.md) para obtener más información. -## API documentation +## Documentación de la API -For full documentation of the API, including the structure of requests and responses, available functionality, and a listing of all endpoints, see the Develop section of the CloudOps Documentation Home: +Para obtener la documentación completa de la API, incluyendo la estructura de solicitudes y respuestas, la funcionalidad disponible y una lista de todos los puntos de conexión, consulta la sección "Develop" de la página principal de la documentación de CloudOps. -- [Develop](https://docs.cloudops.com/#/develop/) +- [Develop](https://docs.cloudops.com/#/develop/) (disponible solamente en inglés) diff --git a/es/automation/automation.md b/es/automation/automation.md index e298e5e..33d3052 100644 --- a/es/automation/automation.md +++ b/es/automation/automation.md @@ -1,3 +1,3 @@ --- name: Automatización ---- +--- \ No newline at end of file diff --git a/fr/automation/automation-cloudops-api.md b/fr/automation/automation-cloudops-api.md new file mode 100644 index 0000000..e54376f --- /dev/null +++ b/fr/automation/automation-cloudops-api.md @@ -0,0 +1,75 @@ +--- +title: "Automatiser les tâches avec l'API CloudOps" +slug: automatiser-taches-avec-api +--- + + + +Cet article est une introduction à l'API REST CloudOps. Il explique comment y accéder et fournit également un contexte pour les autres articles de la catégorie Automatisation. + +## Aperçu + +Pour certaines tâches simples, il peut être utile de les exécuter sans avoir à se connecter à l'interface utilisateur Web CloudOps. Par exemple, vous pourriez avoir besoin d'effectuer plusieurs fois les opérations suivantes : + +- Synchroniser la base de connaissances après modification du contenu +- Générer un rapport mensuel avec des critères et des filtres identiques +- Ajouter de nouveaux utilisateurs à un environnement spécifique + +Dans ce cas, exécuter un seul appel d'API sans avoir à vous connecter à l'interface Web peut vous faire économiser du temps et de l'énergie. De plus, vous pouvez utiliser n'importe quel outil de planification pour déclencher automatiquement vos appels d'API quand vous le souhaitez. + +En tant que plateforme d'orchestration pilotée par API, CloudOps donne accès à toutes les fonctionnalités par le biais de son API REST. Toute fonctionnalité accessible via l'interface Web est accessible via l'API. Tous les appels à l'API sont sécurisés par des connexions HTTPS et une clé API unique à votre compte. + +Les articles de la catégorie Automatisation constituent un point de départ pour les utilisateurs ayant peu ou pas d'expérience avec les outils API. Ils ne visent pas à remplacer la documentation complète de l'API. Il s'agit plutôt d'un guide d'utilisation convivial, avec une approche subtile, riche en exemples, qui évite l'installation de tout logiciel. Chaque exemple peut être adapté à votre situation et peut même être utilisé conjointement pour créer des flux de travail automatisés. + +## À quoi s'attendre + +Pour rendre ce guide accessible au plus grand nombre, les exemples présentés dans ces articles utilisent un utilitaire standard appelé cURL. Ce programme est inclus sur tous les systèmes macOS, Linux et Windows. Il s'agit d'une commande qui peut être collée dans une fenêtre de terminal pour les utilisateurs macOS et Linux, ou dans une invite de commandes ou une fenêtre PowerShell pour les utilisateurs Windows. Une fois exécutée, la commande cURL se connecte à l'API CloudOps via votre compte utilisateur, envoie votre appel d'API au système CloudOps, puis affiche la réponse renvoyée par CloudOps. + +La commande cURL présentée dans chaque exemple est destinée à être copiée à partir de l'article et collée dans un éditeur de texte. Dans cet éditeur, vous pouvez remplacer le texte entre accolades par les valeurs requises, puis coller la commande modifiée dans votre terminal ou votre invite de commande. Par exemple, une commande cURL énumérant tous les environnements auxquels vous avez accès avec votre compte utilisateur pourrait ressembler à ceci : + +``` +curl --request GET \ + --url https://{endpoint-url}/api/v2/environments \ + --header 'Content-Type: application/json' \ + --header 'MC-Api-Key: {api-key}' +``` + +Pour préparer cet exemple, vous allez copier le texte intégral de l'article et le coller dans un éditeur de texte. Pour une meilleure lisibilité, la commande cURL est divisée en plusieurs lignes à l'aide de la barre oblique inverse \('`\`'\) pour forcer le retour à la ligne. \(Utilisateurs Windows, veuillez lire la section réservée aux utilisateurs Windows, car vous devrez utiliser un autre symbole pour effectuer cette opération.\) Notez qu'il existe deux marqueurs qui servent d'espaces réservés aux données que vous allez fournir : `{endpoint-url}` et `{api-key}`. Vous remplacerez ces marqueurs (y compris les accolades qui les entourent) par les valeurs appropriées, comme expliqué dans les sections Clé API et Point de terminaison API. + +Lorsqu'on travaille avec une API, ses fonctionnalités comportent toujours des aspects techniques. Cependant, lors de l'exécution de tâches simples, de nombreux détails peuvent être ignorés sans risque. Par exemple, lors de l'exécution d'une tâche API (souvent appelée « appel d'API »), le système retourne une réponse contenant beaucoup de texte. Ce texte est au format standard JSON. + +Ce mur de texte peut paraître intimidant et méconnaissable. Il contient plusieurs symboles, comme des crochets et des parenthèses. Bien que ces symboles soient importants pour structurer la réponse, ils peuvent être ignorés la plupart du temps, car ils ne contiennent pas les données nécessaires. En particulier, si vous exécutez simplement une opération, vous pourriez simplement rechercher une valeur indiquant « OK » pour indiquer que l'opération a réussi. + +De même, la réponse peut contenir de nombreuses données externes. Par exemple, l'appel d'API ci-haut retourne plusieurs champs avec des valeurs. Il ne s'agit pas simplement d'une liste d'environnements, mais de paramètres relatifs à chaque environnement répertorié. Pour identifier chaque environnement, vous devrez inspecter la réponse afin de trouver la valeur requise. Il est alors important d'entrer la réponse dans un éditeur de texte et d'utiliser la fonction « Rechercher » pour localiser la date cible. Pour les réponses plus complexes contenant un volume de données important, vous pouvez utiliser un éditeur de texte capable de reformater un document JSON afin de le rendre plus lisible. + +Pour un exemple détaillé sur l'analyse des données JSON, consultez l'article [Obtenir l'ID de la base de connaissances](automation-get-knowledge-base.md). + +## Utilisateurs Windows seulement + +Utilisateurs Windows : veuillez noter que vous devrez modifier les exemples avant de pouvoir les utiliser, en raison de la façon dont Windows traite les caractères spéciaux. + +- Si vous utilisez une fenêtre d'**invite de commande** \(`cmd.exe`\) : remplacez la barre oblique inverse par un symbole carat \('`^`'\) +- Si vous utilisez une fenêtre **PowerShell** : remplacez la barre oblique inverse par un espace et un symbole de guillemet inversé \('`` ` ``'\) + +**Attention :** Dans les deux cas, le carat ou le guillemet inversé doit être le dernier caractère de la ligne. + +## Clé API + +Pour utiliser l'API CloudOps, vous devez d'abord vous connecter au système et créer une clé API pour vos requêtes. Cette clé API sert d'identifiants que cURL envoie à CloudOps pour s'authentifier avec votre compte utilisateur. + +L'article suivant décrit les étapes de création d'une clé API : + +- [Générer une clé API CloudOps](../how-to/how-to-cloudmc-api-key.md) + +Une fois votre clé API générée, gardez-la en lieu sûr, car le système ne vous l'affichera plus jamais. Utilisez votre clé API pour remplacer le marqueur « {api-key} » dans les exemples de commandes cURL. + +## Point de terminaison API + +Outre les clés API, la section « Identifiants d'API » du panneau « Paramètres de l'utilisateur » indique également l'URL à utiliser pour se connecter à un point de terminaison. Consultez l'article [Identifiants de l'API](api-credentials.md) pour plus de détails. + +## Documentation de l'API + +Pour la documentation complète de l'API, y compris la structure des requêtes et des réponses, les fonctionnalités disponibles et la liste de tous les points de terminaison, consultez la section « Develop » de la page d'accueil de la documentation CloudOps : + +- [Develop](https://docs.cloudops.com/#/develop/) (disponible seulemente en anglais) +