Clear
La API Clear Spreadsheet está diseñada para ser la solución definitiva para desarrolladores que necesitan purgar programáticamente elementos no deseados de archivos de hoja de cálculo en una única llamada fiable. Esta página de documentación sirve como tu guía completa, guiándote a través de todo lo necesario para comenzar a integrar el servicio en tus aplicaciones con confianza. Comenzamos con una visión general de los conceptos básicos de la API, explicando cómo el servicio interpreta los diferentes formatos de hoja de cálculo, que van desde los modernos archivos Office Open XML (.xlsx) hasta los binarios legados de Excel (.xls), así como Apple Numbers, CSV, TSV y una variedad de otras representaciones tabulares. Comprender estas particularidades de los tipos de archivo es esencial porque cada formato almacena hipervínculos, imágenes, gráficos y objetos incrustados en estructuras distintas; la API Clear abstrae esas complejidades y presenta una interfaz uniforme que funciona en todos los casos.
Características principales
A continuación, encontrarás una guía detallada del flujo de autenticación. La plataforma utiliza claves de API estándar de la industria y tokens OAuth 2.0 opcionales para garantizar que solo los clientes autorizados puedan invocar operaciones de limpieza de datos. Las mejores prácticas de seguridad, como la rotación de claves, la lista blanca de IP y la transmisión cifrada mediante HTTPS, se explican en profundidad, asegurando que puedas proteger tanto tu infraestructura como los datos de los usuarios finales. Tras la autenticación, la sección "Getting Started" (Comenzando) ofrece un ejemplo de código rápido en varios lenguajes (cURL, Python, JavaScript, .NET y Java), mostrando cómo construir la carga de la solicitud, adjuntar el archivo de hoja de cálculo e interpretar la respuesta. El ejemplo muestra la solicitud más ligera posible: solo tu clave de API, los datos del archivo y una lista opcional de tipos de elementos a eliminar, demostrando la promesa de la API de "una única llamada sencilla".
Documentos
Parámetros
- format: El nombre de la operación, que puede ser: clearAll, clearHyperlinks, clearTables, clearPictures, clearShapes, clearComments, clearCharts, clearOleObjects, clearTextboxes, clearScenarios
- AppRequest.OperationTables: El nombre de la operación, que puede ser: clearAll, clearHyperlinks, clearTables, clearPictures, clearShapes, clearComments, clearCharts, clearOleObjects, clearTextboxes, clearScenarios
- UploadFileRequest.OperationId: Este es un ID de operación
- UploadFileRequest.Files: Estos son los archivos que debes subir a nuestros servicios en línea; puedes preparar los datos a tu manera, pero deben seguir el estándar del elemento de entrada HTML de tipo file.
Usar el endpoint
-
Envía una solicitud que incluya los archivos y el token de acceso Clear API
curl -X 'POST' \ 'https://api.sheetize.cloud/clear' \ -H 'accept: text/plain' \ -H 'Authorization: Bearer TheAccessToken' \ -H 'Content-Type: multipart/form-data' \ -F 'AppRequest.OperationTables=clearHyperlinks' \ -F 'UploadFileRequest.OperationId=' \ -F 'UploadFileRequest.Files=@AFileName.xlsx;type=application/vnd.openxmlformats-officedocument.spreadsheetml.sheet' -
El servicio responderá con una URL de descarga para el archivo procesado, en este ejemplo es:
{ "name": "", "type": "1", "size": 900000, "description": "", "linkToDownload": "/download/TheFolderName/TheFileName.xlsx", "message": "", "statusCode": 200 } -
Envía una solicitud que incluya el nombre del archivo y el nombre de la carpeta a Download API
curl -X 'GET' \ 'https://api.sheetize.cloud/download/TheFolderName/TheFileName.xlsx' \ -H 'accept: */*' \ -H 'Authorization: Bearer TheAccessToken' - Recibirás el archivo y podrás usarlo o simplemente transferirlo al siguiente paso de tu flujo de trabajo.