uip es init & del creador de conectores Conector

Sintaxis y opciones para andamiar, editar, inspeccionar y validar un conector local de Integration Service: inicio del constructor, aplicación preestablecida de inicio, eliminación de encabezado de inicio, inspección y validación.

Parte de la cadena de herramientas de creación local uip is connectors builder . Esta página cubre los dos verbos que pertenecen al shell en disco de un conector:

• builder init : crea un nuevo conector o edita campos en el que se resuelve desde el directorio actual. También es propietario de init preset apply (iniciar un paquete de configuración base/paginación) y init header delete (eliminar un encabezado de solicitud global).
• builder inspect / builder validate — resumen de estructura de solo lectura y conjunto de comprobaciones de aprobación/error calificable por CI. Estos se encuentran directamente debajo de builder, sin contenedor connector en la ruta de comando.

Para actividades de andamiaje, autenticación, desencadenadores o ediciones de archivos de bajo nivel, consulta las páginas relacionadas.

Conceptos

• Crear vs. editar envío : init decide su modo en función de si un conector se resuelve desde --connector-dir (o el directorio actual, escaneando solo el propio directorio actual, no los subdirectorios, a diferencia de la resolución alternativa de otros comandos del creador). Ningún conector resuelve → crear (requiere --name, aplica andamios a un árbol nuevo e inicia los valores predeterminados). Uno resuelve → editar (solo cambian los marcadores que pasas; todo lo demás en el disco se deja como está). Si coincide más de un directorio de conectores, init falla con Code: "connectorAmbiguous" en lugar de adivinar: pasa --connector-dir explícitamente.
• Por qué init no escanea subdirectorios : cada otro comando del creador recurre a escanear subdirectorios inmediatos cuando no se resuelve ningún conector en el directorio actual (consulta Conceptos en la página principal). init omite deliberadamente esa alternativa: el análisis correría el riesgo de resolver un directorio de conector hermano por debajo de cwd y editarlo o cambiarle el nombre de forma silenciosa en lugar de crear uno nuevo. Ejecuta init desde el propio directorio del conector, o pasa --connector-dir para editar uno en otro lugar.
• Lo que init se pliega : este único comando reemplaza lo que solían ser superficies independientes connector scaffold, metadata set, global set y base/paginación config preset , por lo que los otros tres verbos de creación (auth, activity, trigger) se mantienen estrechos. Los campos de cola larga element.json /metadatos no expuestos como marcadores aquí (displayOrder, extended, typeOauth, cloneable, tags, …) pasan por state patch en la página Desencadenador y estado en su lugar.
• Requisito de inicio de sesión al crear : crear un conector sin --organization requiere un inicio de sesión activo, porque la clave del elemento (design-{org}-{slug}) marca la organización. Esto comprueba el estado de inicio de sesión real, no solo si un nombre de la organización se almacena en caché localmente: una sesión caducada o con error de actualización falla la comprobación aunque uip login status en sí mismo aún informara de éxito. Pasa --organization <slug> explícitamente para compilaciones sin conexión o CI.
• Asimetría de creación de encabezado frente a eliminación : añadir o actualizar un encabezado global se incluye en init --header VendorName=value (repetible). Eliminar uno es init header delete <vendor-name> independiente: la única operación de encabezado que state patch no puede hacer, porque no puede abordar un único elemento de matriz element.json parameters[] directamente.

Sinopsis

uip is connectors builder init [--name <name>] [--connector-dir <path>] [options...]
uip is connectors builder init preset apply --kind <base|pagination> [--override <key=value>]... [--connector-dir <path>] [--force]
uip is connectors builder init header delete <vendor-name> [--connector-dir <path>]
uip is connectors builder inspect [--connector-dir <path>]
uip is connectors builder validate [--connector-dir <path>]

uip es init del creador de conectores

Crear o configurar el shell de un conector en el disco.

Nota:

Úsalo para iniciar un conector nuevo (--name), o para establecer campos en el nivel de conector (nombre, descripción, categorías, URL base, encabezados, ciclo de vida, nivel) en uno que ya exista. Para añadir recursos/actividades, utiliza activity create en la página Actividad y enlaces . Para configurar la autenticación más allá del Sugar --auth en línea, utiliza auth set en la página Auth . Para editar un campo element.json de cola larga que este comando no expone como un marcador, utiliza state patch.

Opciones

Largo	Valor	Descripción
--name <name>	String	Nombre para mostrar, por ejemplo 'Acme Widgets'. Obligatorio al crear; la clave del elemento y la carpeta predeterminada se derivan de ella.
--connector-dir <path>	Ruta	Directorio del conector. Consulta los conceptos anteriores para ver el comportamiento de resolución específico de init.
--organization <name>	Slug	Slug de la organización para la clave del elemento (design-{org}-{name}). Solo modo de creación; el valor predeterminado es su organización en la que ha iniciado sesión.
--description <text>	String	Descripción del conector de una línea.
--categories <csv>	csv	Lista de categorías separadas por comas. La coincidencia no distingue entre mayúsculas y minúsculas; los valores aprobados se canonicalizan a su ortografía aprobada (por ejemplo crm → CRM). Una categoría no reconocida falla rápidamente aquí en lugar de más tarde en validate.
--activity-color <hex>	HEX	Color hexadecimal para la IU de la actividad de Studio.
--base-url <url>	url	URL base predeterminada: establece la entrada de configuración base.url. Una URL con plantilla (https://{environment}/api) inicia automáticamente la entrada de configuración de interpolación de respaldo que necesita.
--accept-type <value>	String	Accept valor del encabezado.
--content-type <value>	String	Content-Type valor del encabezado.
--header <kv>	VendorName=value	Encabezado de solicitud global. Repetible.
--lifecycle-stage <stage>	String	Etapa del ciclo de vida, por ejemplo GA, BETA.
--tier <tier>	String	Nivel de conector.
--auth <type>	String	Configurar la autenticación en línea (solo modo crear): cualquier valor auth set --auth-type (oauth2, customApiKey, none, jwtOauth, firstPartyService, …). Con oauth2, --authorization-url, --token-url y --scope son obligatorios. Los marcadores específicos de tipo más allá de los siguientes necesitan auth set.
--authorization-url <url>	url	URL de inicio de sesión/consentimiento de OAuth2. Obligatorio con --auth oauth2.
--token-url <url>	url	Punto final del token OAuth2. Obligatorio con --auth oauth2.
--token-refresh-url <url>	url	Punto final de actualización de OAuth2. El valor predeterminado es --token-url.
--token-revoke-url <url>	url	Punto final de revocación del token OAuth2.
--scope <scope>	String	Cadena de ámbito delimitada por espacios de OAuth2. Obligatorio con --auth oauth2.
--api-key-param-name <name>	String	customApiKey — encabezado del proveedor o nombre del parámetro de consulta.
--api-key-location <where>	header | query	customApiKey — donde se envía la clave. Predeterminado header.
--api-key-prefix <prefix>	String	customApiKey — prefijo literal.
--key-config-name <key>	String	customApiKey — clave de configuración interna. Predeterminado custom.api.key.
--key-config-display-name <name>	String	customApiKey — Etiqueta de IU. Predeterminado API Key.
--force	Marca	Aplicar diferencias en las entradas existentes en lugar de errores.

Ejemplos

# Create a new connector (auth configured later)
uip is connectors builder init --name 'Acme Widgets'

# Create + OAuth2 + base URL in one call
uip is connectors builder init --name 'Acme Widgets' --base-url https://api.acme.com \
  --auth oauth2 --authorization-url https://acme.com/oauth/authorize \
  --token-url https://acme.com/oauth/token --scope 'read write'

# Edit an existing connector — only the passed flags change
uip is connectors builder init --description 'Acme Widgets connector' --categories crm,sales

Forma de datos (--json de salida)

{
  "Code": "ConnectorInitialized",
  "Data": {
    "Mode": "created",
    "ElementKey": "design-myorg-acmewidgets",
    "RepoName": "acme-widgets",
    "ConnectorRoot": "/work/periodic-design-myorg-acmewidgets",
    "FilesCreated": ["app/element/element.json", "..."],
    "OrganizationName": "myorg",
    "OrganizationNameSource": "login",
    "HeadersSeeded": [],
    "BaseUrlSet": false,
    "MetadataChanges": [],
    "AuthConfigured": null
  }
}

Mode es "created" o "edited". El modo de edición devuelve una forma Data más estrecha: Mode, ConnectorRoot, HeadersChanged, MetadataChanges, BaseUrlSet — no hay FilesCreated, OrganizationName o AuthConfigured, ya que solo se aplican a un andamio nuevo.

uip es el ajuste preestablecido de inicio del creador de conectores

Aplica un paquete canónico de entradas de configuración: base (URL base más claves de selección/anulación/instancia) o pagination (las cuatro claves de paginación).

Nota:

Utilízalo para inicializar las claves de configuración base o de paginación en una llamada. El paquete de eventos/sondeo es un valor preestablecido independiente al que se accede a través de trigger create --event-kind, no a través de este comando. Para añadir una entrada de configuración personalizada en lugar de un paquete, utiliza state patch element.json/configuration/<key>.

Opciones

Largo	Valor	Descripción
--kind <kind>	base | pagination	Obligatorio. Ajuste preestablecido que se aplicará.
--override <kv>	key=value	Anulación de defaultValue por entrada. Repetible.
--connector-dir <path>	Ruta	Directorio del conector.
--force	Marca	Aplicar diferencias en las entradas existentes en lugar de errores.

Ejemplo

uip is connectors builder init preset apply --kind pagination

Forma de datos (--json de salida)

{
  "Code": "ConfigPresetApplied",
  "Data": {
    "Kind": "pagination",
    "Added": ["pagination.max"],
    "Updated": [],
    "Unchanged": [],
    "ConnectorRoot": "/work/periodic-design-myorg-acmewidgets"
  }
}

uip es eliminar encabezado de inicio del creador de conectores

Eliminar un encabezado de solicitud global por nombre de proveedor.

Nota:

Utilízalo para eliminar un encabezado global que ya no quieres que se envíe. Para añadir o actualizar uno, utiliza init --header VendorName=value — no hay init header create; esa operación vive en sí misma init.

Argumentos

Nombre	Obligatorio	Propósito
<vendor-name>	Sí	Nombre del encabezado del proveedor que se eliminará.

Opciones

Largo	Valor	Descripción
--connector-dir <path>	Ruta	Directorio del conector.

Ejemplo

uip is connectors builder init header delete X-Tenant

Forma de datos (--json de salida)

{
  "Code": "GlobalHeaderRemoved",
  "Data": { "ConnectorRoot": "/work/periodic-design-myorg-acmewidgets", "VendorName": "X-Tenant" }
}

uip es la inspección del creador de conectores

Produce una descripción general estructurada de solo lectura de un conector: tipos de autenticación, configuración, recursos (con archivos y enlaces de recursos estándar), enlaces globales, eventos y metadatos.

Nota:

Utilízalo para obtener un mapa rápido de un conector existente antes de editarlo, o para confirmar qué recursos, enlaces y tipos de autenticación están presentes. Para las comprobaciones de éxito/error en lugar de un resumen de estructura, utiliza validate.

Opciones

Largo	Valor	Descripción
--connector-dir <path>	Ruta	Directorio del conector.

Ejemplo

uip is connectors builder inspect --connector-dir ./my-acme-connector

Forma de datos (--json de salida)

{
  "Code": "ConnectorInspected",
  "Data": {
    "ConnectorRoot": "/work/my-acme-connector",
    "ElementKey": "design-myorg-acmewidgets",
    "Name": "Acme Widgets",
    "Description": "Acme Widgets connector",
    "AuthTypes": ["oauth2"],
    "ConfigCount": 5,
    "ConfigKeys": ["base.url", "..."],
    "ResourceCount": 12,
    "ResourceSummary": {
      "/auth_validation": { "Methods": ["GET"], "Type": "standard", "StandardResourceFile": "auth_validation.json", "Hooks": [] }
    },
    "GlobalHooks": [],
    "HasEvents": false,
    "EventTypes": [],
    "Categories": ["CRM"],
    "LifecycleStage": "GA",
    "Metadata": { "...": "verbatim element-metadata.json content" }
  }
}

ResourceSummary está marcado por la ruta real en disco del recurso (por ejemplo /auth_validation), y Metadata es el contenido textual de element-metadata.json. Ambos están exentos de la normalización de claves PascalCase habitual de CLI: las claves sin procesar se conservan exactamente como aparecen en el disco, por lo que un selector creado a partir de esta salida (por ejemplo /auth_validation, {sys_id}) coincide con la ruta real del archivo en lugar de una variante /authValidation / {sysId} alterada.

uip es la validación del creador de conectores

Ejecuta el conjunto de comprobaciones completo en un conector y emite un informe estructurado. Sale distinto de cero cuando el conector no es válido, para que CI pueda utilizarlo.

Nota:

Utilízalo para bloquear un conector en CI antes de importarlo o lanzarlo, y para encontrar errores, advertencias y sugerencias en element.json, archivos de recursos estándar, enlaces y metadatos. Para navegar por la estructura de un conector en lugar de ejecutar comprobaciones, utiliza inspect.

Opciones

Largo	Valor	Descripción
--connector-dir <path>	Ruta	Directorio del conector.

Ejemplos

uip is connectors builder validate

uip is connectors builder validate --connector-dir ./my-acme-connector

Forma de datos (--json de salida)

{
  "Code": "ConnectorValidation",
  "Data": {
    "ConnectorRoot": "/work/my-acme-connector",
    "ElementKey": "design-myorg-acmewidgets",
    "Valid": true,
    "Errors": [],
    "Warnings": [],
    "Info": ["Configuration entries: 5"],
    "Summary": "PASS: 0 error(s), 0 warning(s)"
  }
}

El informe se emite tanto con aprobación como con error: un informe fallido sigue devolviendo Result: "Success" con Valid: false en Data (el comando en sí no dio error), pero el proceso finaliza con un código de salida distinto de cero para que CI pueda en el resultado sin analizar el cuerpo.

Relacionado

• uip es creador de conectores : conceptos y verbos del ciclo de vida del tenant (download/import/publish/publish-status).
• Auth : configura el esquema de autenticación del conector.
• Actividad y enganches : define lo que hacen las actividades del conector.
• Desencadenador y estado : desencadenadores de eventos y ediciones de archivos de elementos de bajo nivel.

Ver también

• Descripción general de la herramienta de Integration Service
• Opciones globales
• Códigos de salida