Acceso a API externa
El acceso a la API externa proporciona los datos de vehículos que se importan y sincronizan dentro de WordPress.
Ver documentación relacionadaAPI Y WEBHOOKS
Integración controlada de API y webhooks para plataformas de vehículos en WordPress
Revise cómo ADP Car Market Hub se conecta a datos externos de vehículos, gestiona las credenciales de API, expone endpoints técnicos, soporta flujos de trabajo de webhooks y valida la comunicación de red segura.
Visión general de API y webhooks del plugin WordPress ADP Car Market Hub
Esta página resume las interfaces técnicas implicadas en la conexión de ADP Car Market Hub con fuentes de datos externas y flujos de trabajo de integración basados en WordPress.
Gestión de credenciales
Las credenciales autorizan las solicitudes de API y solo deben almacenarse en la configuración protegida del plugin.
Ver documentación relacionadaEndpoints REST y AJAX
Los endpoints técnicos soportan las operaciones del plugin, los flujos de trabajo del frontend y las interacciones controladas del administrador de WordPress.
Ver documentación relacionadaFlujos de trabajo de webhooks
La documentación de webhooks explica cómo se pueden gestionar los eventos de integración o señales externas donde esté soportado.
Ver documentación relacionadaDiagnósticos y soporte
Las pruebas de conexión, los registros y los documentos de resolución de problemas ayudan a identificar solicitudes fallidas, endpoints bloqueados o errores de configuración.
Ver documentación relacionadaArquitectura de conexión para flujos de trabajo de API y webhooks
Una integración de API fiable depende de solicitudes salientes seguras, credenciales válidas, configuración correcta de endpoints y gestión de errores observable.
- Fuente externa de datos de vehículos Proporciona datos estructurados del inventario de vehículos a través del acceso API configurado.
- Solicitud HTTPS a la API El servidor de WordPress debe poder alcanzar los endpoints externos a través de HTTPS seguro.
- Autenticación y credenciales Las credenciales de API validan el acceso y determinan qué inventario se puede recuperar.
- Plugin WordPress ADP Car Market Hub Gestiona la configuración, las pruebas de conexión, las importaciones y el procesamiento interno.
- Procesamiento de importación Transforma los datos externos en registros de vehículos de WordPress, metadatos y medios.
- Base de datos y biblioteca de medios de WordPress Almacena el contenido importado de vehículos, imágenes, configuraciones, registros y datos operativos relacionados.
- Flujos de trabajo REST, AJAX y frontend Soportan acciones de administración controladas, interacciones del frontend y comportamiento de integración.
- Registros, diagnósticos y soporte Ayudan a diagnosticar fallos de conexión, problemas de endpoints y errores de integración.
Credenciales de API y requisitos de acceso
El acceso a la API debe configurarse cuidadosamente porque las credenciales controlan qué datos externos puede solicitar el plugin.
Valores requeridos
- URL base de la API
- URL del token
- ID de cliente
- Secreto de cliente
- ID del vendedor o identificador de cuenta
- Entorno de la API
- Endpoint de prueba de conexión donde esté configurado
Reglas de gestión de credenciales
- No publique credenciales en la documentación
- No incluya credenciales en los repositorios
- Almacene las credenciales solo en la configuración protegida del plugin
- Limite el acceso a administradores de confianza
- Confirme los permisos de la cuenta antes de importar
- Rote las credenciales cuando cambie el acceso
- Use credenciales de staging para pruebas de staging cuando sea posible
Red, SSL y pruebas de conexión
La mayoría de los problemas de API son causados por solicitudes salientes bloqueadas, credenciales inválidas, problemas de SSL, URLs incorrectas o problemas de permisos de cuenta.
Sitio web HTTPS válido
URL de API externa válida
Solicitudes HTTPS salientes permitidas
Ningún firewall del alojamiento bloqueando llamadas a la API
La resolución DNS funciona desde el servidor
La cadena de certificados SSL es válida
Endpoint de token accesible
URL base de la API accesible
Credenciales introducidas correctamente
Acceso del vendedor o cuenta confirmado
Prueba de conexión completada
Registros relevantes revisados
Superficie REST API y AJAX expuesta por el plugin
El plugin puede usar endpoints de API REST y acciones AJAX para operaciones de administración controladas, flujos de trabajo del frontend y comportamiento de integración.
Endpoints de API REST
Técnico
La documentación de la API REST describe la superficie de endpoints del plugin, el comportamiento esperado y los límites de uso técnico.
- Espacio de nombres del endpoint
- Propósito de la solicitud
- Contexto de autenticación
- Respuestas esperadas
- Gestión de errores
- Verificaciones de seguridad
Acciones AJAX
Técnico
La documentación AJAX describe las interacciones controladas de administración o frontend que dependen del comportamiento AJAX de WordPress.
- Propósito de la acción
- Verificaciones de nonce
- Verificaciones de capacidad
- Validación de entrada
- Formato de respuesta
- Gestión de errores
Integración de webhooks para flujos de trabajo basados en eventos
La documentación de webhooks explica cómo se pueden gestionar los eventos de integración o señales externas donde esté soportado por el flujo de trabajo del plugin.
Casos de uso de webhooks
Use webhooks para entender cómo los patrones de integración basados en eventos pueden complementar las importaciones programadas y las acciones manuales.
Integración de webhooksGestión de webhooks
La gestión de webhooks debe validar el origen de la solicitud, sanear la entrada, registrar los fallos y evitar exponer datos privados.
Documentación técnica de webhooksResolución de problemas de webhooks
Las llamadas de webhook fallidas deben diagnosticarse mediante registros, accesibilidad del endpoint, verificaciones de autenticación y validación del payload.
Resolución de problemasLa disponibilidad y el comportamiento de los webhooks dependen de la versión del plugin instalada y del escenario de integración configurado.
Reglas de seguridad y operativas para integraciones de API
Las integraciones de API y webhooks deben documentarse y operarse sin exponer datos sensibles.
Prácticas de integración seguras
- Use HTTPS para toda la comunicación externa
- Restrinja el acceso a las credenciales a administradores autorizados
- Valide las URLs de la API antes de importar
- Use credenciales de staging para pruebas donde estén disponibles
- Monitorice las solicitudes de API fallidas
- Revise los registros sin exponer datos personales
- Documente solo el comportamiento público
No publique
- Secretos de cliente
- Tokens de API
- URLs de API privadas
- Datos del cliente
- Datos personales
- Payloads de webhook sin procesar con datos privados
- Rutas internas del servidor
- Detalles de implementación sensibles a la seguridad
Resolución de problemas y diagnósticos para problemas de API y webhooks
Cuando falla la comunicación de API o webhooks, comience con pruebas de conexión, credenciales, reglas de red y registros.
| Problema | Causa probable | Verificación recomendada | Documentación |
|---|---|---|---|
| La prueba de conexión falla | URL incorrecta, solicitud saliente bloqueada o problema de SSL | Compruebe la URL de la API, DNS, firewall del alojamiento y cadena SSL | Red y SSL de la API Errores de conexión de la API |
| La autenticación falla | ID de cliente, secreto de cliente, endpoint de token o permisos de cuenta inválidos | Compruebe las credenciales y el acceso a la cuenta del vendedor | Configuración de credenciales de la API Credenciales de API externa |
| Las importaciones no devuelven vehículos | El ID del vendedor, el mapeo de cuenta o los permisos de la API no coinciden con el inventario esperado | Compruebe el acceso a la cuenta y la configuración de importación | Configuración de la API de AutoScout24 |
| Webhook no recibido | Endpoint no accesible o emisor externo no configurado | Compruebe la URL del webhook, la autenticación y los registros | Integración de webhooks |
| La solicitud AJAX falla | Problema de nonce, permiso o solicitud mal formada | Compruebe la consola del navegador, los permisos de administrador y los registros | Acciones AJAX |
| La solicitud REST falla | Problema de autenticación, capacidad o endpoint | Compruebe el espacio de nombres del endpoint, el método de solicitud y la respuesta | Endpoints de API REST |
Referencias para desarrolladores sobre endpoints de API y webhooks
Los desarrolladores pueden usar la documentación técnica para revisar el comportamiento de los endpoints, los puntos de extensión, la gestión de solicitudes y los límites de integración.
API REST para desarrolladores
Referencia técnica para desarrolladores que integran con la superficie de API REST del plugin.
API REST para desarrolladoresAcciones AJAX para desarrolladores
Documentación para desarrolladores sobre gestión de acciones AJAX, nonces y verificaciones de capacidad.
Acciones AJAX para desarrolladoresEndpoints de API REST
Referencia técnica de todos los endpoints REST expuestos por el plugin.
Endpoints de API RESTAcciones AJAX
Referencia técnica de todas las acciones AJAX registradas por el plugin.
Acciones AJAXWebhooks
Documentación técnica sobre el comportamiento de webhooks y patrones de integración.
WebhooksVerificaciones de seguridad y capacidad
Patrones de seguridad, verificaciones de capacidad y control de acceso para los endpoints del plugin.
Documentación para desarrolladoresSaneamiento y escape
Patrones de saneamiento de entrada y escape de salida utilizados en todo el código del plugin.
Documentación para desarrolladoresRegistro y depuración
Registro, salida de depuración y herramientas de diagnóstico disponibles para desarrolladores.
Documentación para desarrolladoresGuía de pruebas
Orientación de pruebas y flujos de trabajo de aseguramiento de calidad para integraciones del plugin.
Documentación para desarrolladoresDocumentación de API y webhooks en el repositorio público
Abra los documentos relevantes de API, webhooks, red y desarrolladores directamente en el repositorio de documentación pública.
Guía de integración
Primeros pasos y requisitos
- Configuración de credenciales de la API
- Requisitos de red y SSL de la API
- Errores de conexión de la API
Documentación técnica
- Endpoints de API REST
- Acciones AJAX
- Documentación técnica de webhooks
- Sección de documentación técnica
Documentación para desarrolladores
- API REST para desarrolladores
- Acciones AJAX para desarrolladores
- Sección de documentación para desarrolladores
- Sección de resolución de problemas
Los enlaces de documentación siguen el idioma activo del sitio web. El inglés es el idioma de origen. Las carpetas de otros idiomas usan nombres de carpetas y archivos localizados.