Crear o editar un token de API
Para crear un token de API, vaya a la Página de tokens de API y haga clic + Nuevo token API. En la página Create API Token que se abre, configure la información básica y los grupos de permisos para el token. Consulta las secciones a continuación para obtener más información.
Basic Info
En esta sección, completa la configuración básica del token API. Consulta la imagen comentada a continuación para obtener más información.
Nombre del token. Ingrese un nombre único para el token. Este campo es obligatorio.
Nota
Solo puede usar caracteres en minúsculas, dígitos, guiones y guiones bajos para completar este campo. No se admiten mayúsculas ni caracteres especiales.
Activo. Alternar que muestra si el token está activo o inactivo. De forma predeterminada, el estado es Activo. Para desactivar el token, haga clic en el interruptor.
Expires Fecha en la que caduca el token de la API. De forma predeterminada, el campo de caducidad está deshabilitado (atenuado). Para establecer una fecha de caducidad, haga clic en la casilla de verificación Caducidad. Luego, haga clic en el campo de fecha o en el icono de calendario y seleccione una fecha. Este campo es opcional.
Cliente. Cliente al que está asociado el API Token. Haz clic en la flecha y selecciona un cliente en el menú desplegable.
Importante
El campo Client solo está disponible para los usuarios partner y superadmin. La casilla de verificación Todos los clientes está disponible solo para usuarios superadministradores.
Después de completar la sección Basic Info, debes completar la sección Permissions Groups.
Permissions Groups
En esta sección, selecciona los grupos de permisos para los productos dentro de la plataforma Veritran que desea integrar con el token API. Consulta la imagen comentada a continuación para obtener más información.
Importante
Los usuarios del cliente tienen esta sección disponible por defecto. En el caso de los usuarios socios y superadministradores, esta sección solo estará disponible después de que se complete el campo Cliente en la sección Básico.
Barra de búsqueda. Para encontrar un grupo de permisos, haga clic en la barra de búsqueda y escriba su nombre.
Grupos de permisos por cliente. Haga clic en la casilla de verificación para seleccionar todos los permisos establecidos para cada entorno del cliente. El número ubicado a la izquierda de la casilla de verificación refleja la cantidad de permisos seleccionados para ese cliente (chips de color azul) y asociados al token API.
Grupo de permisos por entorno. Puede seleccionar grupos de permisos de forma masiva o individual. Para seleccionar todos los grupos de permisos dentro de un entorno, haga clic en la casilla de verificación. Para seleccionar grupos de permisos individualmente, haga clic en cada ficha de grupo de permisos. El número ubicado a la izquierda de la casilla de verificación refleja la cantidad de grupos de permisos seleccionados para ese entorno (chips de color azul) y asociados al token API.
Sugerencia
Los grupos de permisos de clientes se identifican con un ícono de persona ubicado a la izquierda del nombre del grupo. Los grupos de permisos de entorno se identifican con un icono de pila ubicado a la izquierda del nombre del grupo.
Detalles del grupo de permisos. Haga clic en el ícono de información ubicado a la derecha del chip del grupo de permisos para ver o editar la configuración de ese permiso. Se abre un panel que contiene los detalles sobre el cliente, el entorno y la versión del entorno, y los permisos otorgados. Hacer clic Regresa para volver a la configuración del token API. Hacer clic Editar ir al configuración del grupo de permisos y hacer todos los cambios necesarios.
Una vez que completes todos los campos obligatorios, haz clic en Save. Aparece un mensaje emergente que confirma que el token de la API se creó correctamente. Además, se abre un modal que contiene el enlace del token. Hacer clic Copiar token y cerrar para copiar el token y volver a la lista de tokens API.
Para editar un token API desde el Página de tokens de API, búsquelo en la lista, haga clic en el icono de tres puntos verticales a la derecha y luego haga clic en Editar. Se abre la página Editar token de API, donde puede modificar la información básica y los permisos del token de API. La página de edición le permite modificar los mismos campos que completó al crear el token API. Hacer clic Ahorrar para confirmar los cambios. Aparece un mensaje emergente que confirma que el token de la API se actualizó correctamente.