viafirma inbox :: manual de administrador

Sistemas API

En este panel de administración se permite la gestión de credenciales para que terceras aplicaciones puedan interactuar con las API’s de la plataforma. Se recomienda la creación de un sistema API para cada tercera aplicación que vaya a consumir los servicios del sistema.

Al acceder a esta opción, se mostrará un listado con los sistemas ya dados de alta, donde podremos visualizar el Nombre Corto del mismo, la Fecha de Creación, la Key del Sistema (contraseña) y una serie de Acciones que podremos realizar.

API List

En el listado de sistemas existentes se dispone de una serie de acciones disponibles:

  • Búsqueda: filtrará el listado de sistemas API introduciendo una cadena de texto y pulsando el botón Buscar. Si queremos volver a tener el listado completo deberemos pulsar el enlace Mostrar todos.
  • Editar (lápiz): mostrará el formulario con los datos del registro donde se podrá modificar el nombre o la descripción del sistema de la fila actual.
  • Ver (lupa): mostrará los datos del sistema API de la fila actual.
  • Eliminar (cruz): se eliminará el sistema API de la fila actual.
  • Regenerar Key (check): si existiese algún problema con la contraseña, pulsando sobre esta acción se crearía una nueva que deberá ser comunicada a los integradores.
  • Eliminar seleccionados: pulsando dicho botón se eliminarán los sistemas API seleccionados en la lista.

Creación y edición de un sistema API

Tanto si se ha seleccionado la opción Añadir o si se ha seleccionado Editar sobre un sistema API existente, se accederá a la pantalla de edición de sistemas API. En el caso de estar editando, los datos saldrán precargados con los del sistema API que estemos editando. En caso de estar añadiendo un nuevo sistema API, estos datos aparecerán sin rellenar, o con sus valores por defecto.

API Edit

Los campos a cumplimentar en este formulario son los siguientes:

  • Nombre Corto: Nombre corto del sistema API (obligatorio).
  • Descripción: Descripción del sistema API.
  • Key Sistema: Contraseña a emplear en la autenticación. Sólo se mostrará si estamos editando un sistema API existente.
  • Utilizar para autenticación básica en destino: En caso de seleccionar esta opción, y que al crear la petición por el servicio web se haya indicado una url de notificación, se emplearán estos mismos datos para autenticar en la llama POST a la url de notificación.
  • Utilizar autenticación Bearer en destino y Bearer Token : En caso de seleccionarse esta opción, y que al crear la petición por el servicio web se ha indicado una url de notificación, se empleará el Bearer Token para autenticar en la llama POST a la url de notificación.

En el caso de nuevos sistemas API, al introducir los datos y guardar, automáticamente se creará una key (contraseña) del nuevo sistema API.

Las aplicaciones externas que deseen integrarse con Viafirma Inbox deberán utilizar el par Nombre Corto/key para identificarse en el API.