Cómo agregar y editar contenido

Estás consultando la documentación de Apigee Edge.
Consulta la documentación de Apigee X. Información

Usa el tipo de contenido "Página básica" de Drupal para agregar documentación sobre tu API, como guías prácticas y documentos de referencia de la API, a tu portal de servicios para desarrolladores y, además, incluye contenido como videos, presentaciones en pantalla o descargas de código.

La página Documentación está configurada con algunas entradas iniciales organizadas en varias categorías, como “Instructivos” y “Comenzar”. La página es un punto de partida que puedes editar. De esta manera, puedes agregar tus propias entradas de contenido y organizarlas de la manera que desees.

Cómo agregar la página principal de Documentación

De forma predeterminada, la página principal de la documentación se encuentra en <siteURL>/document en el portal para desarrolladores. La página principal predeterminada del portal para desarrolladores contiene un vínculo a esta página en el cuadro que se encuentra en la parte superior de la página principal:

También puedes agregar un vínculo de documentación a esta página en el menú principal del menú del portal para desarrolladores.

Sin embargo, la página principal de la documentación no existe de forma predeterminada, por lo que debes crear una página nueva en el portal para desarrolladores con la URL correcta.

Si quieres agregar la página principal de la documentación a tu portal para desarrolladores, haz lo siguiente:

  1. Accede a tu portal como un usuario con privilegios de administrador o de creación de contenido.
  2. En el menú de administración de Drupal, selecciona Contenido > Agregar contenido > Página básica.
  3. Ingresa el título del documento, como la página principal de la documentación, y el contenido de la primera página.
  4. Haz clic en Edit summary para agregar un resumen.
  5. Haz clic en el elemento Menu settings debajo de la sección Body.
  6. Selecciona Provide a menu link, agrega el título del vínculo y selecciona <Main menu> en el elemento superior.
    Se agregará un vínculo al menú principal de la página principal de la documentación.
  7. Haz clic en el elemento Configuración de ruta de URL que se encuentra debajo de la sección del cuerpo.
  8. Anula la selección de Generar alias de URL automático y configura el alias de URL como documentación.
    De forma predeterminada, la URL de una página es <siteURL>/content/pageName. Cuando configuras el alias de la URL, estableces una URL explícita de la página, en este caso <siteURL>/document.
  9. Guarda la página.
    Ahora deberías ver un vínculo a la página en la barra de menú, y el vínculo en el cuadro de la página principal debería funcionar.
    Como administrador, también podrás ver los botones de administración de contenido, como Ver y Editar. Los usuarios que no sean administradores no podrán verlos.

Cómo agregar una página secundaria a tu documentación

A medida que agregues páginas secundarias a tu documentación, ten en cuenta lo siguiente:

  1. Accede a tu portal como un usuario con privilegios de administrador o de creación de contenido.
  2. En el menú de administración de Drupal, selecciona Contenido > Agregar contenido > Página básica.
  3. Ingresa el título de la página y el contenido.
  4. Haz clic en Edit summary para agregar un resumen.
  5. Haz clic en el elemento Menu settings debajo de la sección Body.
  6. Selecciona Provide a menu link y agrega el elemento de menú de la página principal de la documentación.



    Esta acción agrega una página actual como elemento secundario del menú principal de la página principal de la documentación.
  7. Ahora deberías ver un vínculo a la página en el menú de la página principal de la documentación.

Edita una página de documentación

Para editar una página, haz lo siguiente:

  1. Accede a tu portal como un usuario con privilegios de administrador o de creación de contenido.
  2. Navega a la página en el portal para desarrolladores.
    También puedes hacer clic en Contenido en el menú de administración de Drupal para enumerar todas tus páginas y seleccionar una.
  3. Selecciona la pestaña Editar en la página.


  4. Abre un editor visual. Para ello, selecciona HTML completo o HTML filtrado en el menú desplegable Formato de texto debajo de la sección Cuerpo.
    Deberías ver el contenido de la página en el editor.
  5. Edita la página según sea necesario.

  6. Haz clic en “Guardar”.

Muestra una página de documentación

Para mostrar el contenido de un documento, haz lo siguiente:

  1. Accede a tu portal como un usuario con privilegios de administrador o de creación de contenido.
  2. En el menú de administración de Drupal, selecciona Contenido.
  3. Selecciona el documento que deseas ver.

Cómo reorganizar el orden de las páginas

Puedes cambiar la secuencia y el nivel de anidación de las páginas en el menú principal de la documentación.

Sigue estos pasos para reorganizar las páginas en el menú principal de la documentación:

  1. Accede a tu portal como un usuario con privilegios de administrador o de creación de contenido.
  2. En el menú de administración de Drupal, selecciona Structure > Menus > Main menu.
  3. Cada elemento del menú tiene un ícono a la izquierda de su nombre. Si no ves los íconos, haz clic en Ocultar pesos de fila.
  4. Para mover un elemento, haz clic y arrastra el ícono para moverlo a una nueva ubicación.
    Arrastrar un elemento con elementos secundarios también mueve los elementos secundarios.


  5. Haz clic en Guardar configuración.

Cómo editar las páginas del pie de página

El pie de página del portal contiene tres íconos de redes sociales para Twitter, Facebook y LinkedIn, además de vínculos con las siguientes URLs:

  • Política de privacidad de la URL <siteURL>/privacy-policy
  • Condiciones y uso de la URL <siteURL>/terms-use
  • Páginas de contacto a la URL <siteURL>/contact-us

Edita estas páginas para agregar tu propio contenido.

Si estas páginas no existen, créalas:

  1. Accede a tu portal como un usuario con privilegios de administrador o de creación de contenido.
  2. En el menú de administración de Drupal, selecciona Contenido > Agregar contenido > Página básica.
  3. Ingresa el título del documento, como la Política de Privacidad, y el contenido de la página.
  4. Haz clic en Edit summary para agregar un resumen.
  5. Haz clic en el elemento Configuración de ruta de URL que se encuentra debajo de la sección del cuerpo.
  6. Selecciona Generar alias de URL automático y configura el alias de URL como política de privacidad.
    De forma predeterminada, la URL de una página es <siteURL>/content/pageName. Cuando configuras el alias de la URL, estableces una URL explícita de la página, que en este caso es <siteURL>/privacy-policy.
  7. Guarda la página.
  8. Repite este proceso para las páginas de Términos y uso y Contacto.

Sigue estos pasos para editar el contenido de una página de pie de página, como la Política de Privacidad, las Condiciones de Uso o la página de contacto, en el portal para desarrolladores:

  1. Accede a tu portal como un usuario con privilegios de administrador o de creación de contenido.
  2. Navega a la página haciendo clic en el vínculo que se encuentra en el pie de página. Por ejemplo, haz clic en el vínculo Política de Privacidad.
  3. Haz clic en la pestaña Editar de la página para abrir el editor.
  4. Cambia el contenido de la página de la Política de Privacidad según corresponda.
  5. Haz clic en Guardar.
  6. Repite este proceso para las páginas de Términos y uso y Contacto.

Sigue estos pasos para editar los íconos de redes sociales, como los de Twitter, Facebook y LinkedIn, en tu portal para desarrolladores:

  1. Accede a tu portal como un usuario con privilegios de administrador o de creación de contenido.
  2. Selecciona Structure (Estructura) > Blocks (Bloques) en el menú de administración de Drupal.
  3. Desplázate hacia abajo en la página Bloqueos hasta que veas el bloque Pie de página predeterminado en todo el sitio.
  4. Selecciona el vínculo configure correspondiente al bloque de pie de página predeterminado en todo el sitio.
  5. En el área Contenido personalizado, haz clic con el botón derecho en el ícono de una red social y selecciona Editar vínculo en el menú emergente. También puedes borrar el ícono del área de contenido personalizado para quitarlo.
  6. Selecciona Guardar bloque para guardar los cambios.

Agregar JavaScript a una página del portal

Puedes agregar JavaScript a cualquier página del portal. La manera más fácil de agregar JavaScript es editar la página y, luego, sigue estos pasos:

  1. En Formato de texto, selecciona HTML completo.
  2. Selecciona el botón Fuente para editar el código fuente HTML de la página.
  3. Agrega JavaScript a la página. Por ejemplo, para que aparezca un cuadro de alerta cuando se cargue la página, agrega el siguiente código:

    <script language="JavaScript">
    alert('Welcome to my page!');
    </script>

Algunas consideraciones sobre el uso de JavaScript:

  • Si vas a hacer referencia a un archivo JavaScript, no lo hagas en el código fuente de un nodo, ya que eso creará un vínculo estático. En su lugar, usa código PHP para crear un vínculo dinámico. De esa manera, si la ubicación del archivo JavaScript cambia, no es necesario que actualices todas las páginas del portal que hacen referencia a él.
  • Si deseas incluir un archivo JavaScript, agrégalo al tema del portal. O bien, si forma parte de un módulo de Drupal, agrégalo al módulo.
  • También puedes usar la función drupal_add_js de Drupal para agregar JavaScript en Drupal. Para obtener más información, consulta https://api.drupal.org/api/drupal/includes!common.inc/function/drupal_add_js/7.

Te recomendamos que revises el contenido para buscar vínculos rotos. De forma predeterminada, el portal para desarrolladores está configurado a fin de verificar varios tipos de páginas en busca de vínculos rotos. Por ejemplo, se verifican los vínculos en páginas, artículos, entradas de blog y temas de foros básicos.

Para agregar o quitar tipos de páginas de la verificación de vínculos, sigue estos pasos:

  1. En el menú de administración de Drupal, selecciona Modules y asegúrate de que el módulo Link Checker esté habilitado.
  2. En el menú de administración de Drupal, selecciona Configuración > Creación de contenido > Verificador de vínculos.
  3. Configura los tipos de contenido que quieres que se analicen en busca de vínculos rotos.

Cómo configurar la búsqueda

El portal para desarrolladores proporciona un motor de búsqueda integrado que implementa Apache Solr, el cual usa la biblioteca de búsqueda de Apache Lucene. Se trata del motor de búsqueda del sitio, al que el usuario accede a través del cuadro de búsqueda que se encuentra en la esquina superior derecha de todas las páginas del portal.

Los motores de búsqueda externos, como Google, también pueden indexar tu portal. El portal para desarrolladores te permite controlar si los motores de búsqueda externos pueden indexar tu portal.

Cómo configurar Apache Solr

Puedes configurar Apache Solr para controlar los tipos de contenido que se indexarán, forzar un índice y realizar tareas de configuración adicionales.

Para configurar Apache Solr, sigue estos pasos:

  1. Accede a tu portal como un usuario con privilegios de administrador o de creación de contenido.
  2. En el menú de administración de Drupal, selecciona Configuración > Búsqueda y metadatos > Búsqueda de Apache Solr.
  3. Usa esta página para configurar Apache Solr.

Cómo inhabilitar la indexación de Google

También te recomendamos que indexes tu contenido y lo pongas a disposición de los motores de búsqueda. De forma predeterminada, el indexador de Google indexa tu contenido. Sin embargo, tienes la opción de inhabilitar la indexación de Google. Te recomendamos que lo hagas si tu portal para desarrolladores no está listo para su uso público y, por lo tanto, no quieres que tu contenido se pueda buscar de forma pública.

Para inhabilitar la indexación de Google, haz lo siguiente:

  1. Accede a tu portal como un usuario con privilegios de administrador o de creación de contenido.
  2. Selecciona Modules en el menú de administración de Drupal.
  3. Habilita el módulo de Metaetiquetas.
  4. Haz clic en Guardar configuración.
  5. En el menú de administración de Drupal, selecciona Configuración > Búsqueda y metadatos > Metaetiqueta.
  6. Selecciona la operación Override para el tipo global.
  7. Haz clic en la sección Opciones avanzadas para abrirla.

  8. Marca la casilla de verificación Evitar que los motores de búsqueda indexen esta página.
  9. Haz clic en Guardar.

Ten en cuenta que hay otras opciones relacionadas con los motores de búsqueda en la sección Configuración avanzada de la página Global. Por ejemplo, puedes marcar una casilla de verificación para evitar que los motores de búsqueda sigan los vínculos de una página. Marca una o más de estas casillas de verificación según corresponda.

Documenta cómo registrar apps

Es importante que la documentación incluya instrucciones sobre cómo los desarrolladores pueden registrar sus apps a través del portal para desarrolladores. Puedes usar las siguientes instrucciones como punto de partida; en estas instrucciones, se explica cómo registrar apps mediante el portal para desarrolladores predeterminado.

Para configurar la manera en que los desarrolladores registran apps en tu portal, consulta Configura el registro de apps para obtener más información. Si modificas el proceso de registro de la app, modifica las instrucciones de ejemplo que aparecen a continuación según corresponda.

Si quieres registrar una app mediante el portal para desarrolladores predeterminado, haz lo siguiente:

  1. Selecciona Mis apps debajo de tu nombre de usuario en el menú de acceso.
  2. Haz clic en el ícono de la app Add (+) nueva.

  3. Ingresa los valores adecuados en la página Agregar app:
    Nombre de la app Proporciona un nombre de app único para tu app.
    URL de devolución de llamada

    Si es necesario, proporciona la URL de devolución de llamada a la que debe devolverse la llamada de OAuth.

    De forma predeterminada, este valor es obligatorio incluso si tus APIs no usan OAuth. Si tus APIs no usan OAuth, ingresa un valor ficticio, como my.site.com.
    Product Selecciona uno o más productos de API.
  4. Haz clic en Crear app para registrar la app y generar la clave de API para esta.