Proceso de certificación de editor distinto de Microsoft
Este proceso es para editores que no son de Microsoft (excluidos los editores independientes). Si es un editor independiente, vaya a Proceso de certificación de editores independientes.
Una vez que finalice el desarrollo del conector personalizado, siga estos pasos para prepararlo para su certificación y generar los archivos del conector para enviárselos a Microsoft.
Nota
Este tema proporciona información para certificar conectores personalizados en Azure Logic Apps, Power Automate y Power Apps. Antes de seguir los pasos de este artículo, lea la información general de Certificar un conector y registre su conector personalizado en Microsoft.
Paso 1: Registrar su conector
No es preciso que haya terminado el desarrollo del conector personalizado para solicitar su certificación. Para comenzar el proceso de certificación, registre su conector para la certificación completando nuestro formulario de registro.
Espere un correo electrónico en un plazo de dos días hábiles de un contacto de Microsoft, quien:
- Comprenderá su conector personalizado.
- Obtendrá información sobre el progreso de desarrollo.
- Lo guiará por el proceso de certificación.
Paso 2: Cumplir los requisitos de envío
Para mantener un alto estándar de calidad y consistencia entre nuestros conectores certificados, Microsoft tiene un conjunto de requisitos y pautas que su conector personalizado debe cumplir para la certificación.
Dele un título a su conector
- Debe existir y estar escrito en inglés.
- Debe ser único y distinguible de cualquier título de conector existente.
- Debe ser el nombre de su producto u organización.
- Debe seguir los patrones de nomenclatura existentes para conectores certificados.
- No puede tener más de 30 caracteres.
- No puede contener las palabras "API", "Conector" ni ninguna de nuestros nombres de producto de Power Platform (por ejemplo, "Power Apps").
- No puede terminar en un carácter no alfanumérico, incluidos el retorno de carro, una nueva línea o un espacio en blanco.
Ejemplos
- Buenos títulos de conectores: "Azure Sentinel", "Office 365 Outlook"
- Títulos de conectores deficientes: "Conector de Power Apps de Azure Sentinel", "API de Outlook de Office 365"
Escriba una descripción para su conector
- Debe existir y estar escrito en inglés.
- NO debe tener errores gramaticales ni ortográficos.
- Debe describir de manera concisa el propósito principal y el valor ofrecido por el conector.
- No puede tener menos de 30 caracteres ni más de 500 caracteres.
- No puede contener ningún nombre de producto de Power Platform (por ejemplo, "Power Apps").
Diseñe un icono para el conector
Esta sección no se aplica a los editores independientes.
- Cree un logo de aproximadamente 160 × 160 píxeles dentro de un cuadrado de aproximadamente 230 × 230 píxeles (sin bordes redondeados).
- Debe contener un fondo de color no transparente, no blanco (#ffffff) y un color no predeterminado (# 007ee5) que coincida con el color de fondo del icono especificado.
- Debe ser exclusivo para cualquier otro icono de conector certificado.
- Se debe enviar en formato PNG como
icon.png.
Defina resúmenes y descripciones de operaciones y parámetros
- Debe existir y estar escrito en inglés.
- NO debe tener errores gramaticales ni ortográficos.
- Los resúmenes de operaciones y parámetros deben ser frases de 80 caracteres o menos y contener solo caracteres alfanuméricos o paréntesis.
- Las descripciones de operaciones y parámetros deben ser oraciones completas, frases descriptivas y terminar con una puntuación.
- No puede contener ningún nombre de producto de Microsoft Power Platform (por ejemplo, "Power Apps").
Defina respuestas operativas exactas
- Defina las respuestas de la operación con un esquema exacto solo con las respuestas esperadas.
- No utilice respuestas predeterminadas con una definición de esquema exacta.
- Proporcione definiciones de esquema de respuesta válidas para todas las operaciones en el Swagger. No se permiten esquemas de respuesta vacíos. Esto significa que no se mostrará contenido dinámico en la salida y los creadores deben usar JSON para analizar la respuesta.
Crear cadenas de idioma de calidad en inglés
Los conectores se localizan como parte de la localización de Power Automate; por lo tanto, cuando está desarrollando un conector, la calidad de las cadenas del idioma inglés es clave para la calidad de la traducción. Estas son algunas de las áreas principales en las que debe centrarse al crear los valores de las cadenas que proporcionará.
Asegúrese de ejecutar un programa de revisión ortográfica para asegurarse de que todos los valores de cadena no tengan errores tipográficos. Si hay alguna cadena en inglés incompleta, el resultado de la traducción será incompleto o incorrecto en contexto.
Asegúrese de que la oración esté completa. Si la oración no está completa, eso también puede generar traducciones de menor calidad.
Asegúrese de que el significado de la oración sea claro. Si el significado de la oración es ambiguo, eso también puede generar traducciones de menor calidad o incorrectas.
Evite las cadenas compuestas en tiempo de ejecución, si es posible. En su lugar, use oraciones completamente terminadas. Las cadenas u oraciones concatenadas dificultan la traducción o pueden provocar una traducción incorrecta.
Si usa abreviaturas, asegúrese de ponerlas en mayúscula para que quede claro. Esto reducirá la posibilidad de que se confunda con un error tipográfico.
Las cadenas con formato CaMel (por ejemplo, minimizeHighways o MinimizeHighways) normalmente se consideran no traducibles. Si desea localizar el valor de la cadena, debe corregir el formato CaMel de la cadena.
Paso 3: Agregar metadatos
Los artefactos (archivos) del conector deben contener metadatos específicos que describan el conector y su servicio final. La información proporcionada en los metadatos se publicará en la documentación de nuestro conector y todos los usuarios podrán acceder a ella. No proporcione ningún tipo de información privada o confidencial y avísenos a través de su contacto de Microsoft si hay algún problema al proporcionarnos esta información. Para aprender cómo se documentarán los metadatos, visite cualquiera de las páginas de la documentación específica del conector en Referencia del conector.
Paso 3a: propiedades del editor y stackOwner
Editor es el nombre de su empresa u organización. Proporcione el nombre completo de la empresa (por ejemplo, "Contoso Corporation"). Este debe estar en formato alfanumérico.
"stackOwner" es la empresa u organización propietaria de la pila de servicios de back-end a la que se conecta el conector. Este debe estar en formato alfanumérico.
Ubicación del archivo: apiProperties.json
Sintaxis: las propiedades editor y stackOwner existen como propiedades de nivel superior dentro del archivo apiProperties.json. Agregue las siguientes líneas resaltadas como se muestra. Asegúrese de introducir el nombre de propiedad y el esquema exactamente como se muestra.
Código que muestra dos líneas resaltadas en rojo. Las dos líneas son para editor y stackOwner, y se encuentran situadas directamente después del corchete de cierre en "capacidades": ["acciones"] :::image-end:::
Paso 3b: metadatos del producto o servicio final
"contacto" describe cómo los usuarios pueden ponerse en contacto con los recursos de soporte del producto o el servicio final para obtener ayuda o solución de problemas. Proporcione un valor para cada uno de los siguientes:
- Nombre del equipo de soporte
- Dirección URL del sitio web de soporte técnico
- Correo electrónico de soporte
"Sitio web" es el sitio web del producto o servicio final. Ofrece a los usuarios información sobre el producto o servicio final que están utilizando con el conector. Debe ser un URL.
Directiva de privacidad se refiere a la directiva de privacidad pública del producto o servicio final, o de su empresa u organización. Debe ser un URL.
Las categorías se refieren a una clasificación lógica de su conector entre, como máximo, dos de las siguientes categorías: IA, gestión empresarial, inteligencia empresarial, colaboración, comercio, comunicación, contenido y archivos, finanzas, datos, recursos humanos, Internet de las cosas, operaciones de TI, estilo de vida y entretenimiento, marketing, productividad, ventas y CRM, seguridad, redes sociales, sitio web.
Ubicación del archivo: apiDefinition.swagger.json
Sintaxis: el objeto contacto es un campo estándar definido por el contrato de OpenAPI bajo la propiedad info de nivel superior. Sitio web, Política de privacidad y Categorías se definirán en una extensión personalizada de nivel superior llamada x-ms-connector-metadata. El valor de la propiedad Categorías es una cadena delimitada por signos de punto y coma. Agregue los fragmentos de código con líneas rojas como se muestra. Asegúrese de introducir el esquema exactamente como se muestra; no cambie el valor de propertyName.
Código que muestra el bloque que define el objeto de contacto resaltado en rojo. Este bloque debe ubicarse directamente debajo de la descripción. Otro bloque, x-ms-connector-metadata, también está resaltado en rojo. Este bloque debe ubicarse directamente debajo de las rutas: {}.
Paso 3c: fragmentos de código de ejemplo
Puede utilizar los siguientes fragmentos de código para copiar e introducir su información. Asegúrese de agregar los fragmentos a los archivos correctos en las ubicaciones correspondientes como se describe en la sección anterior.
"publisher": "_____",
"stackOwner": "_____"
"contact": {
"name": "_____",
"url": "_____",
"email": "_____"
}
"x-ms-connector-metadata": [
{
"propertyName": "Website",
"propertyValue": "_____"
},
{
"propertyName": "Privacy policy",
"propertyValue": "_____"
},
{
"propertyName": "Categories",
"propertyValue": "_____;_____"
}
]
Nota
Existe una limitación actual en el uso de la propiedad stackOwner y nuestra herramienta CLI de Paconn. Para obtener más información, vaya a Limitaciones en el archivo README.
Paso 3d: valide sus archivos de conector personalizados
Ejecute el paconn validate --api-def [Location of apiDefinition.swagger.json]. Esta herramienta validará la definición del conector y le indicará los errores que debe corregir antes del envío.
Si el conector usa OAuth como tipo de autenticación, agregue a la aplicación estas direcciones URL de redireccionamiento permitidas:
https://global.consent.azure-apim.net/redirecthttps://global-test.consent.azure-apim.net/redirect
Paso 4: Preparar los artefactos del conector
Completar este paso debería llevarle aproximadamente una semana.
Nota
Antes de la certificación debe asegurarse no solo de que ha seguido las especificaciones, sino también de la calidad del conector. Si no lo hace, la certificación se retrasará, ya que se le pedirá que realice cambios.
Va a enviar a Microsoft un conjunto de archivos denominados artefactos del conector, que se descargan mediante una herramienta de interfaz de línea de comandos (CLI) proporcionada por Microsoft. Esta herramienta validará su conector en busca de errores de interrupción.
Siga estos pasos para comenzar:
Instale la herramienta CLI de conectores de Microsoft Power Platform siguiendo las instrucciones de instalación.
Inicie sesión en Microsoft Power Platform desde la línea de comandos, ejecutando
paconn login. Siga las instrucciones para iniciar sesión mediante el proceso de código de dispositivo de Microsoft.Una vez autenticado, descargue los archivos de conector personalizados:
- Ejecute el
paconn download. Seleccione el entorno en que se encuentra el conector personalizado, para lo que debe especificar su número en la línea de comandos y, después, seleccione el nombre del conector personalizado.
La herramienta descargará los artefactos de su conector en una carpeta a la ubicación del sistema de archivos donde ejecutó
paconn. Dependiendo del tipo de editor, encontrará diversos artefactos:Publicador Artefacto Editor independiente apiDefinition.swagger.jsonapiProperties.jsonEditor que no es de Microsoft (que no sea independiente) apiDefinition.swagger.jsonapiProperties.jsonsettings.json
Icono de conector- Ejecute el
Crear un artefacto de archivo Léame
Un archivo Readme.md es necesario tanto para editores independientes como para editores que no son de Microsoft. Debe crear un archivo Readme.md para documentar las características y la funcionalidad de su conector. Para ver un ejemplo de documentación para incluir, vaya al ejemplo de Readme.md.
Paso 5: Enviar el conector para su implementación
Nota
Durante el proceso de envío, estará abriendo el código de su conector a nuestro Repositorio de conectores de Microsoft Power Platform.
Siga las instrucciones de Enviar su conector para certificación de Microsoft para enviar a GitHub y al portal de certificación.
Una vez que envíe una solicitud de extracción al repositorio de código abierto, Microsoft implementará y validará su conector en dos días hábiles. Si se requieren actualizaciones, espere dos días hábiles adicionales.
Como parte del envío, Microsoft validará su conector utilizando las herramientas CLA-bot, Swagger Validator y Breaking Change Detector. Si necesita solucionar los errores de Swagger, vaya a Corregir errores del validador de Swagger.
Paso 6: expectativas de pruebas realizadas por editores que no son de Microsoft
Después de validar su conector, le pediremos que realice una prueba exhaustiva.
Siga las instrucciones de Poner a prueba un conector en la certificación para crear un entorno en la región de vista previa como preparación para sus pruebas.
En el plazo de una semana, notifique a su contacto de Microsoft que ha completado las pruebas para que podamos comenzar la implementación.
Una vez que tanto Microsoft como usted hayan validado la funcionalidad y el contenido de su conector, prepararemos el conector para su implementación en la región de versión preliminar para realizar pruebas.
Paso 7: esperar a la implementación
Una vez que el conector se haya validado para la prueba, lo implementaremos en todos los productos y regiones.
Importante
En promedio, se necesitan entre 7 y 10 días hábiles para implementar el conector. Esto es obligatorio independientemente del tamaño o la complejidad de su conector, ya sea nuevo o actualizado. Para proteger la integridad, el conector se someterá a las mismas tareas de validación para probar la funcionalidad y el contenido que se siguen en cada implementación.
Le notificaremos por correo electrónico con los nombres de las regiones en las que se implementará el conector, ya que la implementación en las regiones se realiza en pasos. Si hay un retraso o congelación de la implementación, los editores que no son de Microsoft pueden encontrar el estado en el Control de actividad en el Portal de ISV. Los editores independientes recibirán una notificación por correo electrónico.
Implementación de producción
Nuestros programas de implementación de conectores para producción comienzan los lunes y miércoles por la mañana, PST/PDT. Deberá informar a Microsoft de que está listo para la implementación de producción con al menos 24 horas de anticipación para que incluyamos su conector en la próxima implementación programada. Los editores que no son de Microsoft pueden notificarnos en el Control de actividad del Portal de ISV. Los editores independientes pueden notificar a su contacto de Microsoft.
Implementación de región
La implementación en distintas regiones se lleva a cabo en una secuencia diaria predeterminada. Las regiones son:
- Pruebas.
- Versión preliminar de EE. UU.
- Asia, excepto Japón e India.
- Europa, excepto Reino Unido.
- Brasil, Canadá, Japón e India.
- Australia, Reino Unido y EE. UU.
Por ejemplo, si su conector está programado para implementarse el lunes, se implementará en la región de prueba el día 1. Luego se implementará en la región de versión preliminar de EE. UU. el Día 2. La implementación continuará diariamente hasta que el conector se implemente en las seis regiones.
No implementamos los viernes, sábados, domingos y feriados de EE. UU.
A medida que su conector vaya terminando la certificación, lo contactaremos para tratar una oportunidad de marketing para el conector en el blog de Power Automate.
Paso 8: Explorar las opciones posteriores a la implementación
A continuación, se muestran algunas opciones que puede explorar una vez que se haya implementado el conector:
Ver la telemetría del conector en cualquier momento en el Portal de ISV. Para ver el estado y el uso de su conector, vaya a Obtener información clave sobre su conector certificado en el portal ISV.
Enviar actualizaciones a su conector. Para obtener más información, vaya a Actualización de un conector certificado.
Supervise su conector en el foro de discusión de la comunidad para descubrir si los clientes encuentran algún problema o tienen solicitudes de funciones para su conector.
Solicitar la eliminación de la etiqueta de versión preliminar. Una vez que el conector ha estado disponible públicamente durante algún tiempo y cumple ciertos requisitos, puede calificar para reasignarle la etiqueta Disponibilidad general. Esta etiqueta mostrará que el conector es un producto listo para producción. Para obtener más detalles, vaya a Mover su conector de la vista previa a la disponibilidad general.
Lista de comprobación antes del envío
Antes de pasar a Enviar conectores para que Microsoft los certifique, asegúrese de que:
Su conector cumple todos los estándares establecidos en Paso 2: cumplir requisitos de envío y Paso 3: agregar metadatos.
A ninguna operación le falta un resumen, una descripción o información de visibilidad.
Ha probado su conector personalizado para asegurarse de que las operaciones funcionan como se esperaba (al menos 10 llamadas exitosas por operación).
No aparecen errores de tiempo de ejecución o validación de esquema en la sección de prueba del asistente para conector personalizado.
Si es un editor que no es Microsoft (y no un editor independiente), se le pedirá que acepte nuestro Contrato de partner y el contrato de no divulgación al enviar para solicitar la certificación de Microsoft. Si desea revisar las condiciones y el idioma antes de realizar el envío, póngase en contacto con el contacto de Microsoft.