. . |
Secciones de este artículo:
Modo en tiempo real y modo de prueba
Estado de la solicitud de firma
Devoluciones de llamada de la aplicación
Devoluciones de llamada de la cuenta
Uso de las solicitudes de firma
Modo en tiempo real y modo de prueba
Antes de poner tu aplicación en marcha, puedes probar las solicitudes en el modo de prueba. Esto te ayuda a determinar si el flujo de trabajo está organizado tal como lo quieres, y te permite gestionar los comportamientos inesperados antes de empezar a utilizar la aplicación.
Para mostrar las solicitudes realizadas en el modo de prueba, haz clic en el botón para cambiar de En tiempo real a Prueba. Puedes revertir el cambio y regresar al modo en tiempo real para que se muestren los eventos de tu sitio en vivo en el panel de la API.
Estadísticas
La pestaña Estadísticas te ofrece una vista general de tus datos de API. Desde el hub principal, puedes consultar rápidamente las solicitudes de la API, el estado de las solicitudes de firma y, en forma de gráficos, los datos de uso de las solicitudes de firma. Puedes personalizar los datos que se muestran en tu línea de tiempo según el tipo de dato, el intervalo de fechas y el estado de error (distribución de errores de la API, extremo o estado HTTP) mediante el menú desplegable de la parte superior de la página. También puedes consultar los registros de la actividad de la aplicación y de la cuenta.
En la pestaña Estadísticas también puedes ver cuánto has usado de tu límite (las solicitudes de firma restantes), así como información básica de facturación.
Estado de la solicitud de firma
Puedes ver los id. de los documentos, el estado de las solicitudes de firma y las fechas y horas de los eventos desde la pestaña Estado de la solicitud de firma. Con el menú desplegable de la parte superior de la página, puedes filtrar la información según la fecha y el estado de la solicitud de firma.
Devoluciones de llamada de la aplicación
La pestaña Devoluciones de llamada de la aplicación te ayuda a configurar y monitorear las interacciones con la interfaz de usuario (IU), y te brinda una vista detallada de la interacción con las funciones integradas.
Las devoluciones de llamada de la aplicación se activan cuando ocurre una acción programada (también conocida como “evento”) asociada a una aplicación específica. La información recopilada en esta pestaña solo incluye las solicitudes integradas.
Devoluciones de llamada de la cuenta
La pestaña Devoluciones de llamada de la cuenta te ayuda a configurar y monitorear los eventos del servidor para lograr un flujo de trabajo optimizado con un tiempo de demora mínimo.
Las devoluciones de llamada de la cuenta avisan a tu aplicación cuando se presenta un evento relacionado con tu cuenta. Para ello, se envía la carga útil del evento a la dirección URL de devolución de llamada de tu cuenta; esto se hace cuando se generan todos los datos contenidos en el evento. Puedes usar los menús desplegables para filtrar las devoluciones de llamada de la cuenta por fecha y tipo de evento.
Puedes configurar la dirección URL de devoluciones de llamada de tu cuenta mediante la llamada a la API de la cuenta, o bien de forma manual desde la página Configuración.
Solicitudes de API
La pestaña Solicitudes de API te ofrece una visualización de la funcionalidad de tus solicitudes enviadas para que puedas buscar cualquier error en las solicitudes y solucionarlo.
En la parte superior de la página se encuentra un menú desplegable que permite filtrar las solicitudes de la API por fecha, estado HTTP, método y extremo.
Los códigos HTTP representan el estado de las interacciones entre tu explorador y el servidor. Mediante el panel de la API, puedes filtrar las solicitudes por código de estado HTTP para agilizar la detección de las solicitudes que necesitan atención y las que funcionan según lo previsto.
Descripción de los estados HTTP:
- El estado Informational indica que el servidor aún no completa la solicitud (códigos 100-199).
- El estado Success indica que la solicitud del servidor se completó sin ningún error (códigos 200-299).
- El estado Redirectional indica que se recibió la solicitud, pero se redigirió a otra ubicación (códigos 300-399).
- El estado Client error indica que no se pudo acceder a la página. Este es un error interno del sitio web y suele ocurrir cuando la página no existe en el sitio (códigos 400-499).
- El estado Server error se presenta cuando se realizó una solicitud válida, pero el servidor no pudo completarla como se esperaba (códigos 500-599).
También puedes filtrar las solicitudes de firma por método:
- El método GET se usa para recuperar o leer un recurso.
- El método POST se usa para crear un nuevo recurso.
- El método DELETE se usa para eliminar un recurso por completo.
- El método PUT se usa para modificar un recurso entero.
- El método PATCH se usa para modificar parte de un recurso.
Para filtrar las solicitudes por extremo, sigue estos pasos:
- Crea cualquier otro parámetro de solicitud (fecha, estado HTTP, método) que necesites para esta vista.
- Haz clic en Extremo.
- Haz clic en Personalizado.
- Haz clic en la casilla junto a los extremos correspondientes.
- Haz clic en Aplicar.
La lista de extremos está disponible en la visión general de las solicitudes de firma.
Uso de las solicitudes de firma
Las solicitudes de firma se pueden utilizar para hacer referencia a los datos de solicitudes específicas, como los nombres y las direcciones de correo electrónico de los firmantes, los campos personalizados, los metadatos, los datos de respuesta y las marcas de fecha y hora de cuando se creó la solicitud y cuando se completó. Puedes filtrar los datos de uso por fecha e id. de cliente.
Nota: El uso de las solicitudes de firma también se muestra en el gráfico de la página Estadísticas.
Aplicaciones y claves
La pestaña Aplicaciones y claves te redirige a la página Configuración, donde puedes consultar y administrar tus aplicaciones vinculadas y las claves de API.
Más información sobre la creación y administración de varias claves de API
Descarga de CSV
La pestaña Descarga de CSV muestra el historial de solicitudes de firma de tu cuenta para un intervalo de fechas personalizado. Esta lista puede exportarse en un archivo .csv.
Para ello, sigue estos pasos:
- Inicia sesión en Dropbox Sign.
- Haz clic en API.
- Haz clic en Ver el panel de la API.
- Haz clic en Descarga de CSV.
- Especifica el intervalo de fechas que quieres exportar.
- Haz clic en Descargar CSV.
Visita tu panel de Dropbox Sign API para comenzar.
Recursos relacionados
- Para obtener más detalles sobre las características disponibles y el uso del panel de la API, consulta nuestra Guía del panel de la API.
- Para obtener más información sobre la configuración y ejecución de Dropbox Sign API, consulta nuestra Guía de inicio rápido de la API.
Si tienes preguntas o quieres informar de un problema, envía una solicitud aquí.
Comentarios
0 comentarios
El artículo está cerrado para comentarios.