Proceso de certificación de editor verificado

  • Artículo

Este proceso para editores verificados (excluyendo 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 Certificar un conector y registre su conector personalizado en Microsoft.

Flujo de trabajo del proceso de certificación básico

El siguiente diagrama de flujo muestra el flujo de trabajo del proceso de certificación básico. Los pasos enumerados en este artículo corresponden al flujo de trabajo. Deben proporcionar los detalles que necesita para completar el proceso de certificación.

Para una vista ampliada del diagrama de flujo, seleccione el icono de la lupa en la parte inferior derecha.

Flujo de trabajo del proceso de certificación de conectores.

Para obtener una imagen detallada de este diagrama de flujo, vaya a Flujo de trabajo detallado del proceso de certificación de conectores.

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. Para editores independientes, el nombre del conector debe seguir el patrón Nombre del conector (editor independiente).
  • 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 logotipo con dimensiones 1:1 dentro de un rango de 100 x 100 a 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".
  • Las dimensiones del logotipo están por debajo del 70 % para la altura y el tamaño de la imagen. ancho con fondo consistente.
  • Asegúrese de que el color de la marca sea un color hexadecimal válido y no debe ser blanco (#ffffff) ni predeterminado (#007ee5).

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, excepto en casos especiales en los que el esquema de respuesta es dinámico. Esto significa que no se mostrará contenido dinámico en la salida y los creadores deben usar JSON para analizar la respuesta.
  • No se permiten operaciones vacías.
  • Quite las propiedades vacías a menos que sean necesarias.

Verificar las propiedades de Swagger

  • Asegúrese de que "openapidefinition" esté en un archivo JSON con el formato correcto.
  • Asegúrese de que la definición de Swagger cumpla con el estándar OpenAPI 2.0 y el estándar extendido de los conectores.

Verificar parámetros de conexión

  • Asegúrese de que la propiedad esté actualizada con los valores adecuados para "UIDefinition" (nombre, descripción).

  • Si su parámetro de conexión utiliza autenticación básica, asegúrese de que JSON tenga el formato correcto como en el siguiente ejemplo.

    {
  "username": {
    "type": "securestring",
    "uiDefinition": {
      "displayName": "YourUsernameLabel",
      "description": "The description of YourUsernameLabel for this api",
      "tooltip": "Provide the YourUsernameLabel tooltip text",
      "constraints": {
        "tabIndex": 2,
        "clearText": true,
        "required": "true"
        }
  }
},
  "password": {
    "type": "securestring",
    "uiDefinition": {
      "displayName": "YourPasswordLabel",
      "description": "The description of YourPasswordLabel for this api",
      "tooltip": "Provide the YourPasswordLabel tooltip text",
      "constraints": {
        "tabIndex": 3,
        "clearText": false,
        "required": "true"
      }
    }
  }
}

  • Si su parámetro de conexión utiliza APIKey como autenticación, asegúrese de que JSON tenga el formato correcto como en el siguiente ejemplo.

    {
  "api_key": {
    "type": "securestring",
    "uiDefinition": {
      "displayName": "YourApiKeyParameterLabel",
      "tooltip": "Provide your YourApiKeyParameterLabel tooltip text",
      "constraints": {
        "tabIndex": 2,
        "clearText": false,
        "required": "true"
      }
    }
  }
}

  • Si su parámetro de conexión utiliza Generic OAuth como autenticación, asegúrese de que JSON tenga el formato correcto como en el siguiente ejemplo.

    {
  "token": {
    "type": "oAuthSetting",
    "oAuthSettings": {
      "identityProvider": "oauth2",
      "scopes": [
        "scope1"
      ],
      "redirectMode": "GlobalPerConnector",
      "customParameters": {
        "AuthorizationUrl": {
          "value": "https://contoso.com"
        },
        "TokenUrl": {
          "value": "https://contoso.com"
        },
        "RefreshUrl": {
          "value": "https://contoso.com"
        }
      },
      "clientId": "YourClientID"
    },
    "uiDefinition": null
  }
}

  • Si su parámetro de conexión tiene un proveedor de identidad OAuth2, asegúrese de que el proveedor de identidad esté en la lista de proveedores de OAuth2 admitidos. A continuación se muestra el ejemplo del proveedor de identidad GitHub OAuth2:

    {
  "token": {
    "type": "oAuthSetting",
    "oAuthSettings": {
      "identityProvider": "github",
      "scopes": [
        "scope1"
      ],
      "redirectMode": "GlobalPerConnector",
      "customParameters": {},
      "clientId": "YourClientId"
    },
    "uiDefinition": null
  }
}

  • Si su parámetro de conexión utiliza Microsoft Entra ID como autenticación, asegúrese de que JSON tenga el formato correcto como en el siguiente ejemplo.

    {
  "token": {
    "type": "oAuthSetting",
    "oAuthSettings": {
      "identityProvider": "aad",
      "scopes": [
        "scope1"
      ],
      "redirectMode": "GlobalPerConnector",
      "customParameters": {
        "LoginUri": {
          "value": "https://login.microsoftonline.com"
        },
        "TenantId": {
          "value": "common"
        },
        "ResourceUri": {
          "value": "resourceUri"
        },
        "EnableOnbehalfOfLogin": {
          "value": false
        }
      },
      "clientId": "AzureActiveDirectoryClientId"
    },
    "uiDefinition": null
  }
}

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é en forma 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.

  • Asegúrese de que los resúmenes, los resúmenes x-ms y las descripciones sean gramaticalmente correctos. No los corte y copie. Para saber cómo se muestran dentro del producto, vaya a Guía de cadenas del conectores.

  • 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: ejecutar el comprobador de soluciones para validar su conector

Solution Checker es un mecanismo para realizar análisis estáticos para garantizar que su conector cumpla con los estándares requeridos por Microsoft para la certificación. Agregue su conector a una solución en Power Automate o Power Apps y ejecute el verificador de soluciones siguiendo las instrucciones en Validar un conector personalizado con el verificador de soluciones.

¡Vea este vídeo para saber cómo ejecutar Solution Checker!

Paso 4: 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 4a: propiedades del editor y de 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.

Publicador Descripción Ejemplo
Verificada El editor y stackOwner serán los mismos, a menos que el ISV esté creando un conector en nombre de un stackOwner. "editor": "Tesla",
"stackOwner": "Tesla"
Independiente Debe proporcionar el propietario de la pila y el propietario del editor. "editor": "Nirmal Kumar",
"stackOwner": "ITGlue"

Ubicación del archivo: apiProperties.json
Para obtener más información, vaya al Archivo de propiedades de API.

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.

Captura de pantalla que muestra las propiedades del editor y stackOwner, que están disponibles en fragmentos de código de muestra.

Paso 4c: 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 4d: formato de archivo JSON y limitaciones

  • Asegúrese de que las propiedades estén correctamente alineadas.

  • Pegue su JSON en Visual Studio Code. Siéntase libre de usar extensiones como correctores ortográficos y complementos como complementos JSON.

  • Los archivos de Swagger no deben tener más de 1 MB.

    • Considere el diseño de su conector antes de comenzar a construirlo. Evalúe si el conector debe dividirse en dos (2) o más conectores.
    • Los archivos swagger más grandes pueden causar un retraso al usar el conector.

    Por ejemplo, hay tres (3) conectores diferentes de HubSpot en la plataforma.

    Captura de pantalla de las carpetas de los tres conectores de HubSpot.

Paso 4e: validar los 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/redirect/{apiname}

  • https://global-test.consent.azure-apim.net/redirect/{apiname}

Paso 5: 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.
  • Proporcione una versión de producción de la URL del host. No se permiten direcciones URL de host de ensayo, desarrollo y prueba.

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:

  1. Instale la herramienta CLI de conectores de Microsoft Power Platform siguiendo las instrucciones de instalación.

  2. 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.

  3. 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
Verificada apiDefinition.swagger.json
apiProperties.json
settings.json
Icono de conector
Independiente apiDefinition.swagger.json
apiProperties.json

Tanto los editores verificados como los independientes descargarán apiProperties.json en sus artefactos. Tendrá que establecer IconBrandColor en este archivo.

  • Editores verificados: establezca iconBrandColor en el color de su marca en el archivo apiProperties.
  • Editores independientes: establezca iconBrandColor en "#da3b01" en el archivo apiProperties.
    Captura de pantalla de un icono de color naranja intenso (da3b01).

Crear un artefacto de archivo Léame

Un archivo Readme.md es necesario tanto para editores independientes como para editores verificados. Debe crear un archivo Readme.md para documentar las características y la funcionalidad de su conector. Para ver un ejemplo de la documentación a incluir, vaya al ejemplo de Readme.md. Mire otros archivos Readme.md en nuestro repositorio GitHub para obtener información sobre cómo escribir un archivo Readme.md.

Si es un editor independiente y su conector usa OAuth, asegúrese de incluir instrucciones sobre cómo obtener las credenciales.

Sugerencia

Problemas conocidos y limitaciones es una gran sección para mantener a sus usuarios actualizados.

Paso 6: Enviar el conector para su implementación

Durante el proceso de envío, estará abriendo el código de su conector a nuestro Repositorio de conectores de Microsoft Power Platform.

  1. Siga las instrucciones de Enviar su conector para certificación de Microsoft para enviar a GitHub y al portal de certificación.

    Si es un editor verificado, deberá enviar un archivo script.csx si está utilizando un código personalizado.

  2. Una vez que envíe una solicitud de extracción al repositorio de código abierto, Microsoft implementará y validará su conector en un plazo de 1 a 2 semanas. Si se requieren actualizaciones, espere de 1 a 2 semanas adicionales.

    **Si su conector tiene OAuth, envíe el paquete en ISV Studio y obtenga el nombre de API de la solicitud de envío de su conector para actualizar su aplicación.

    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 7: expectativas de pruebas realizadas por editores verificados

Después de validar su conector, le pediremos que realice una prueba exhaustiva.

  1. Siga las instrucciones de Poner a prueba un conector en la certificación para crear un entorno en la región de versión preliminar como preparación para las pruebas.

  2. En el plazo de una semana, notifique a su contacto de Microsoft que ha completado las pruebas para que podamos comenzar la implementación.

  3. 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 8: 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 de 3 a 4 semanas 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 verificados 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 viernes 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 verificados 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 sábados, domingos y festivos 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 9: 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:

Lista de comprobación antes del envío

Antes de pasar a Enviar conectores para que Microsoft los certifique, asegúrese de que:

Sugerencia

  • Cree vídeos de YouTube, blogs u otro contenido para compartir muestras o capturas de pantalla sobre cómo comenzar a usar el conector.
    - Incluya los enlaces en el archivo Readme.md para que podamos agregarlo a nuestros documentos.
  • Agregue información sobre herramientas a su archivo swagger para ayudar a sus usuarios a tener más éxito.

Si es un editor verificado (y no un editor independiente), se le pedirá que acepte nuestro Acuerdo de socio comercial y el acuerdo de confidencialidad cuando solicite 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.

Siguiente paso

Enviar conectores para que Microsoft los certifique

Proporcionar comentarios

Agradecemos enormemente los comentarios sobre problemas con nuestra plataforma de conectores o nuevas ideas de características. Para enviar comentarios, vaya a Enviar problemas u obtener ayuda con los conectores y seleccione el tipo de comentario.