Thanks for your feedback!
EDIT
Products
En Products puede organizar las documentaciones de sus APIs de acuerdo con las funcionalidades propias de cada producto.
Al importar una API, su documentación se carga automáticamente. También puede agregar documentaciones manualmente. Para saber más detalles, consulte API DOCS.
Listado de productos registrados
En el listado de productos registrados encontrará las siguientes columnas:
-
Product Name: nombre dado al producto;
-
Description: texto descriptivo del producto;
-
Integration: informa cuál de las integraciones se utiliza para el producto;
-
API: APIs asociadas al producto;
-
API Count: cantidad de APIs asociadas al producto;
-
Actions: haga clic en el respectivo ícono para editar, eliminar o visualizar un producto.
Visualizando los productos
Para verificar su producto y asegurar que las APIs correspondientes estén debidamente listadas, siga los pasos a continuación:
-
Acceda a la pantalla o haga clic en la tarjeta Products, en la pantalla inicial de su Dev Portal.
-
Localice el producto que desea visualizar y haga clic en el ícono
.
La pantalla siguiente mostrará la información principal del producto, la descripción y sus APIs.
Al finalizar, haga clic en CANCEL.
Registrando un producto
Siga los pasos a continuación para registrar un producto:
-
Acceda a la pantalla o haga clic en la tarjeta Products, en la pantalla inicial de su Dev Portal.
-
Haga clic en el botón + NEW PRODUCT.
-
En 1 BASIC INFO, complete los campos:
-
Product name: defina un nombre para el producto.
-
Description: escriba una descripción.
-
Roles: establezca uno o más roles.
-
Haga clic en NEXT.
Para tener acceso al producto, será necesario que el usuario posea uno de los roles listados en este campo. Un usuario que tenga un rol que no está listado en el campo roles, no podrá acceder a la API.
-
-
En el paso 2 APIS, elija una integración y agregue una o más APIs.
Para elegir la integración, seleccione una de la lista disponible.
Seleccione la API deseada y haga clic en ADD API.
Repita hasta que todas las APIs para el producto hayan sido agregadas y haga clic en NEXT.Comience a digitar el nombre de la API para ver las opciones disponibles.
-
Paso 3 REVIEW: confirme la información y haga clic en SAVE.
Si necesita editar algo, haga clic en PREVIOUS.
Publicando o eliminando la publicación de un producto
Para publicar o eliminar la publicación de un producto, solo necesita:
-
Acceder a la pantalla o hacer clic en la tarjeta Products, en la pantalla inicial de su Dev Portal.
-
Localizar el producto que desea publicar o eliminar la publicación.
-
Si el botón de alternancia de la columna ACTIONS está activado, el producto está publicado. Haga clic en el botón para desactivarlo y eliminar la publicación.
Editando un producto
Para cambiar un producto, siga los pasos a continuación:
-
En Products, localice el producto que desea editar y haga clic en el ícono
. -
En 1 BASIC INFO, puede (pero no es obligatorio) editar el nombre y la descripción del producto y los roles que pueden acceder a él.
-
Haga clic en NEXT para continuar.
-
Paso 2 APIS: aquí puede cambiar la integración y agregar o eliminar una o más APIs.
Para agregar una API, comience a digitar su nombre, selecciónela y haga clic en ADD API.
Para eliminar, localice la API en la tabla y haga clic en el ícono
. Haga clic en REMOVE para confirmar.
Haga clic en NEXT. -
Paso 3 REVIEW: revise la información y haga clic en el botón SAVE para guardar o en PREVIOUS para volver a editar.
Share your suggestions with us!
Click here and then [+ Submit idea]