Preloader

API Keys

Las API Keys son como contraseñas únicas que abren las puertas a la funcionalidad de nuestra API. Estas claves proporcionan una capa de seguridad robusta al tiempo que permiten a los desarrolladores autorizados acceder y utilizar nuestros recursos de manera eficiente.

En esta sección, exploraremos en detalle cómo las API Keys desempeñan un papel fundamental en la autenticación y autorización de las solicitudes a nuestra API. Más que simplemente una cadena de caracteres, estas claves actúan como un mecanismo de identificación, verificación y control de acceso, asegurando que solo las aplicaciones autorizadas interactúen con nuestros servicios.

Advertencia: Por razones de seguridad, las API Keys sólo pueden ser creadas a través de nuestro portal Web de administración o utilizando autenticación OAuth 2.0.

Roles

El rol de una API Key en Veronica desempeña un papel crucial al establecer niveles de acceso precisos y seguros. Cada rol, actúa como una llave virtual que determina qué áreas y funciones específicas de la plataforma están disponibles para la aplicación que posee esa clave. Recuerde que usted puede seleccionar más de un rol para una misma API KEY.

Rol Nombre Descripción
ROLE_RECEIPTS Comprobantes electrónicos Permite cubrir todo el ciclo de vida de un comprobante electrónico, desde la creación, firmado, envío al SRI, autorización y posterior consulta y notificación. También permitirá al usuario eliminar o anular un comprobante.
ROLE_SUPPLIERS Empresas Permite listar y editar la información de las empresas a las que el usuario tiene acceso.
ROLE_ESTABLISHMENTS Establecimientos Permite listar y editar la información de los establecimientos de las empresas a las que el usuario tiene acceso.
ROLE_EMISSION_POINTS Puntos de emisión Permite listar y editar la información de los puntos de emisión de las empresas a las que el usuario tiene acceso.
ROLE_DIGITAL_CERTS Firmas electrónicas Permite listar, cargar y eliminar archivos de firma electrónica de las empresas a las que el usuario tiene acceso.
ROLE_RIDE_TEMPLATES Plantillas de RIDE Permite listar, crear y eliminar plantillas de RIDE así como su posterior asociación a las empresas a las que el usuario tiene acceso.
ROLE_EMAIL_TEMPLATES Plantillas de correo electrónico Permite listar, crear y eliminar plantillas de correo electrónico así como su posterior asociación a las empresas a las que el usuario tiene acceso.
ROLE_PRODUCTS Productos Permite listar, crear y eliminar productos asociados a las empresas a las que el usuario tiene acceso.
ROLE_REPORTS Reportes Permite consultar reportes asociados a las empresas a las que el usuario tiene acceso.

Al momento de obtener su acceso a la plataforma de Verónica, se le generará una API Key por defecto que contendrá todos los roles mencionados anteriormente. Si bien es cierto que con esta API Key se puede realizar el proceso de integración, se recomienda crear una API Key personalizada dependiendo los tipos de accesos que se quiere otorgar. 

curl --location 'https://api-sobx.veronica.ec/api/v1.0/api-keys' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer [INSERTE TOKEN OAUTH 2.0 AQUÍ]' \
--data '{
    "nombre": "ONBOARDING_API_KEY",
    "expiracionEnDias": 0,
    "roles": [
        "ROLE_RECEIPTS",
        "ROLE_SUPPLIERS",
        "ROLE_ESTABLISHMENTS",
        "ROLE_EMISSION_POINTS",
        "ROLE_DIGITAL_CERTS",
        "ROLE_RIDE_TEMPLATES",
        "ROLE_EMAIL_TEMPLATES",
        "ROLE_PRODUCTS",
        "ROLE_REPORTS"
    ]
}'
curl --location 'https://api.veronica.ec/api/v1.0/api-keys' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer [INSERTE TOKEN OAUTH 2.0 AQUÍ]' \
--data '{
    "nombre": "ONBOARDING_API_KEY",
    "expiracionEnDias": 0,
    "roles": [
        "ROLE_RECEIPTS",
        "ROLE_SUPPLIERS",
        "ROLE_ESTABLISHMENTS",
        "ROLE_EMISSION_POINTS",
        "ROLE_DIGITAL_CERTS",
        "ROLE_RIDE_TEMPLATES",
        "ROLE_EMAIL_TEMPLATES",
        "ROLE_PRODUCTS",
        "ROLE_REPORTS"
    ]
}'
Ver tutorial