Centro de ayuda¿Qué son las credenciales API y para que sirven?
Las credenciales API (o API Keys) son códigos únicos —letras y números— que actúan como identificadores y contraseñas secretas para autenticar software, aplicaciones o usuarios al conectarse a un servicio externo. Sirven para garantizar la seguridad, identificar quién realiza la solicitud, controlar el acceso a datos y gestionar límites de uso (cuotas).
¿Para qué sirven principalmente?
- Autenticación y Seguridad: Verifican que la aplicación que intenta conectarse es legítima, protegiendo el sistema contra accesos no autorizados.
- Identificación de Proyecto: Permiten a la API saber qué aplicación o cliente específico está haciendo la llamada.
- Control de Cuotas y Límites: Ayudan a los proveedores a controlar cuántas solicitudes realiza un usuario, evitando abusos, saturación del sistema o spam.
- Acceso a Funcionalidades/Datos: Permiten el intercambio seguro de información entre diferentes aplicaciones, por ejemplo, conectar un sitio web con Google Maps o un sistema de facturación con Hacienda.
¿Cómo crear la credencial API en Pardux?
- Menú principal.
- Configuraciones.
- Credenciales API.
- Clic en el botón "Nueva credencial".
Se muestra la ventana donde se ingresa la información para la nueva credencial.
**Todos los campos son obligatorios.
Sección de información.
- Nombre *: nombre que se usará para identificar el uso de la API.
- Métodos permitidos *: Acciones/Permisos permitidos (HTTP Methods)Una vez utenticada, la credencial permite utilizar los métodos HTTP estándar sobre los recursos:
- GET: Recuperar información.
- POST: Crear nuevos registros.
- PUT/PATCH: Actualizar o modificar información existente.
- DELETE: Eliminar registros.
- Tipo de restricción:
- Ninguna: ninguna restricción al uso de la credencial.
- IPs autorizadas: se agregan la o las IP donde se autoriza el dispositivo a realizar el uso de la credencial.
Sección de estado:
- Se activa o no mediante un check.
- Clic en Guardar para finalizar el proceso de la creación de la nueva credencial.
- Se muestra la credencial creada con su botón de copia rápido.
PANEL DE INFORMACIÓN DE LISTADO DE CREDENCIALES.
Al crearse la nueva Credencial API se muestra en el panel de listado.
Gestionar o editar credencial.
- Menú principal.
- Configuraciones.
- Credenciales API.
- Clic sobre los tres puntos de la credencial a gestionar.
- Clic en Gestionar.
Eliminar credencial.
- Menú principal.
- Configuraciones.
- Credenciales API.
- Clic sobre los tres puntos de la credencial a eliminar.
- Clic en Gestionar.
- Botón "Eliminar" > Se muestra un aviso.
- Clic nuevamente en el botón "Eliminar" para continuar el proceso.
- Clic en Aceptar para eliminar caso contrario Cancelar.
DOCUMENTACIÓN API
En el módulo de Credenciales API también se muestra la documentación donde se puede hacer uso de la misma.
- Menú principal.
- Configuraciones.
- Credenciales API.
- Clic en el botón "Documentación API".
Se muestra todos los parametros donde se puede hacer uso de la API.
Reemplazar o agregar la credencial API en el campo X-Pardux-ApiKey después de dar clic en Try it out.
