Factuarea APIDevelopers

Comprobar la conexión de una tienda WooCommerce

Comprueba la conexión con una tienda WooCommerce conectada y devuelve el diagnóstico.

  • Lee el estado del sistema de WooCommerce con la credencial guardada y no escribe en la tienda ni en Factuarea.
  • Responde 200 con reachable, credential_accepted, las versiones de WooCommerce y WordPress comunicadas por la tienda (la versión de REST utilizada por el conector está fijada por nosotros), el instante de la comprobación y, si algo falla, un failure_code: woocommerce_store_unreachable (sin respuesta), woocommerce_credentials_rejected (la tienda respondió y rechazó la clave) o woocommerce_rest_route_missing (la tienda respondió, pero no publica su API REST).
  • Son resultados de una comprobación ejecutada y viajan dentro de un 200. El endpoint usa POST porque realiza una llamada de salida a una dirección que has elegido, consume recursos de terceros y exige Idempotency-Key.
  • Una tienda inexistente o de otra empresa devuelve 404 store_not_found.
POST
/woocommerce/stores/{store}/connection-test
AuthorizationBearer <token>

En: header

Parámetros de ruta

store*string

Headers

Idempotency-Key*string

Clave opaca generada por el cliente (hasta 255 caracteres; se recomienda UUID v7) que permite reintentos seguros: la primera respuesta se almacena y se reproduce en las repeticiones sin volver a ejecutar la mutación. Reutilizar una clave con un cuerpo distinto devuelve 409 idempotency_key_reused. Consulta la guía de idempotencia. Obligatoria en esta operación: repetirla produce un efecto irreversible (un email enviado, un archivo generado, una llamada a un tercero o un cargo), por lo que una petición sin esta cabecera se rechaza con 422 idempotency_key_required antes de ejecutar lógica de negocio.

Longitud1 <= length <= 255
Factuarea-Version?string

Fija la versión de la API (YYYY-MM-DD, versionado por fecha estilo Stripe) para esta petición; omítelo para usar la versión fijada de la clave, o la última si no hay ninguna. Versión no soportada → 400 unsupported_api_version; malformada → 400 parameter_invalid_format. La versión efectiva se refleja en la cabecera de respuesta Factuarea-Version. Consulta la guía de Versioning.

Formatodate
X-Active-Profile?string

Opera en nombre de una empresa hija (API key maestra de gestoría): pasa su id público (UUID v7) y la petición se ejecuta contra los datos de esa hija sin cambiar el scope, el tier ni el environment de la clave (omítelo para usar la propia empresa de la clave). UUID inválido → 400 parameter_invalid_uuid; id desconocido o no propio → 404 profile_not_found. Consulta la guía de Acting on behalf.

Formatouuid

Cuerpo de la respuesta

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json