Introducción a la API de Verónica
Estas instrucciones describen cómo enviar su
primera factura electrónica mediante llamadas
cURL. Esta es una de las muchas formas de enviar
facturas electrónicas con la API de
Verónica; también puede realizar la
integración con lenguajes como
PHP, Python, Node.js, Java, C#, Go y Ruby.
Antes de que pueda comenzar a usar la API,
deberá asegurarse de lo siguiente:
- Solicitar una cuenta de prueba
- Cargar un certificado digital válido en la plataforma Web
- Crear una API Key en la plataforma Web ó utilizar la API Key por defecto que Verónica le brinda
- Asegúrese de tener curl o Postman instalado en su computadora
Una llamada de tipo RESTful a la API de Verónica se compone de los siguientes elementos:
Host: Este valor dependerá
del ambiente que esté utilizando, el cual
podrá ser pruebas o producción. Los
valores que el host puede tomar se muestran a
continuación:
Endpoint: Representa cualquiera de las funcionalidades específicas
que queremos invocar de Verónica, las cuales se encuentran listadas en el sitio oficial de la documentación. A continuación se muestra, como ejemplo, el endpoint para emitir una factura utilizando la versión 2.0.
API Key: Deeberá utilizar la API Key que se le generará por defecto al momento de solicitar su cuenta para Verónica o cualquier otra API Key con el rol correspondiente que haya creado posteriormente.
Payload: Al enviar datos a un servicio RESTful a través de POST o PUT, debe enviar su carga útil, también conocida como payload, en formato JSON.
A continuación se muestra un ejemplo de creación de
una factura con un solo detalle y con número de
secuencia 000000001 para la empresa con número de
R.U.C. 9999999999999, la cual posteriormente será
notificada al email no-reply@veronica.ec.
- Host: https://api-sbox.veronica.ec
- Endpoint: /api/v2.0/comprobantes/facturas
- API Key: Se proporcionará al momento de darse de alta en la plataforma
- Payload: Dependerá del tipo de documento que se quiere emitir, en el caso de facturas, podemos dirigirnos al este enlace donde podremos encontrar una gran variedad de ejemplos para facturas y otros documentos inclusive.
Con la información proporcionada anteriormente, podemos construir la llamada de tipo curl que se muestra a continuación:
curl --location --request POST 'https://api-sbox.veronica.ec/api/v2.0/comprobantes/facturas' \
--header 'X-API-KEY: [INSERTE_API_KEY_AQUÍ]' \
--header 'Content-Type: application/json' \
--data-raw '{
"version":"1.0.0",
"fechaEmision":"28/06/2022",
"codDoc":"01",
"ruc":"9999999999999",
"estab":"001",
"ptoEmi":"001",
"secuencial":"000000001",
"receptor":{
"tipoIdentificacion":"04",
"razonSocial":"Hannah Hegmann",
"identificacion":"9999999999999",
"direccion":"665 Edythe Lock"
},
"detalles":[
{
"codigoPrincipal":"B000HQGKRO",
"codigoAuxiliar":"B0000DHW2M",
"descripcion":"HopSlam Ale",
"cantidad":1,
"precioUnitario":209,
"descuento":0,
"detAdicional":[
],
"impuesto":[
{
"codigo":"2",
"codigoPorcentaje":"2",
"tarifa":12,
"baseImponible":209,
"valor":25.08
}
]
}
],
"pagos":[
{
"formaPago":"01",
"total":209,
"plazo":"0",
"unidadTiempo":"Días"
}
],
"moneda":"DOLAR",
"campoAdicional":[
{
"nombre":"email",
"value":"soporte@veronica.ec"
}
]
}'
En caso de éxito, Verónica retornará el siguiente mensaje de respuesta con la clave de acceso de la factura creada:
{
"success": true,
"result": {
"claveAcceso": "0000000000000000000000000000000000000000000000000"
}
}