API cliente | Cardary

Si esta traducción difiere de la versión en inglés, prevalece la versión en inglés.

La API del cliente es un servicio local dentro de la aplicación para la automatización avanzada. No es la API de la nube pública y no debe exponerse a redes que no sean de confianza.

Usos típicos

Utilice la API local cuando desee un script confiable o una herramienta local para:

sincronización de la plataforma de activación;
enumerar plataformas locales o en la nube;
crear una baraja;
buscar una baraja de la nube;
actualizar los metadatos de la plataforma;
eliminar una plataforma local;
enumerar categorías;
crear, actualizar, buscar o eliminar tarjetas;
cargar o eliminar recursos del mazo;
integrar Cardary con un flujo de trabajo personal.

Autenticación

Los puntos finales protegidos requieren el estado de inicio de sesión de la aplicación y un secreto local a través de:

el encabezado X-API-SECRET; o
el parámetro de consulta “secreto”.

Trate el secreto como una credencial. No lo pegue en registros públicos, historial del navegador, scripts compartidos o servicios remotos.

Grupos de puntos finales

La aplicación incluye grupos de puntos finales para:

Grupo	Propósito
Autenticación	Verifique el inicio de sesión y el estado de acceso a la API local.
Sincronización	Activa o inspecciona la sincronización de la plataforma.
Cubiertas	Enumere, cree, busque, actualice y elimine mazos.
Categorías	Leer la estructura de categorías del mazo.
Tarjetas	Busque, cree, actualice y elimine contenido de tarjetas.
Recursos	Cargue y elimine medios o archivos utilizados por las tarjetas.

Las formas exactas de la carga útil pueden cambiar según las versiones de la aplicación. Verifique la implementación de la aplicación al crear una integración estricta.

Reglas de seguridad

Utilice la API solo en máquinas confiables.
No lo vincules a redes públicas.
No compartir el secreto local.
Pruebe primero contra una plataforma pequeña.
Sincronización antes y después de grandes cambios automatizados.
Haga una copia de seguridad o exporte mazos importantes antes de las actualizaciones masivas.
Evite ediciones simultáneas desde la interfaz de usuario y un script a menos que comprenda el comportamiento de sincronización.

Patrones de automatización

Buenos candidatos:

crear una plataforma a partir de una tubería de datos local;
actualizar tarjetas de una exportación CSV revisada;
adjuntar imágenes o audio generados;
activar la sincronización después de una importación controlada;
tarjetas de búsqueda para controles de calidad locales.

Candidatos arriesgados:

eliminar juegos de tarjetas grandes sin copia de seguridad;
reescribir campos en un mazo sin vista previa;
cargar resultados de IA no revisados;
ejecutar scripts mientras otro dispositivo edita el mismo mazo;
exponer la API a través de un servidor remoto.

Solución de problemas

Problema	Qué comprobar
La solicitud no está autorizada	Estado de inicio de sesión y `X-API-SECRET`.
El mazo no se puede editar	Propiedad de la plataforma, estado de solo lectura y compatibilidad con el tipo de plataforma.
La carga de recursos falla	Además de límites de archivos adjuntos, ruta de archivo, tamaño y red.
La sincronización no actualiza otro dispositivo	Ejecute la sincronización en ambos dispositivos y espere los recursos.
Error de carga útil	Compare su solicitud con la implementación actual de la aplicación.

Relacionado: Cuenta y sincronización e Importar tarjetas.