Documentación Collectar

Documentación Collectar

Documentación técnica de integración

Añadir documentos

Estimated reading: 3 minutes 52 views
Añade documentos a una factura ya creada anteriormente

Parámetros de entrada necesarios


El servicio recibe los siguientes parámetros en formato JSON:

  • El contenido del docmento se enviará codificado en Base64

Valores válidos para el campo:

dataDocument

Parámetros de salida


El servicio devolverá un mensaje JSON con los siguientes campos:

Dónde:

  • Error: código de resultado,  devolverá uno de los valores indicados en la siguiente tabla

El campo firma se compondrá mediante el siguiente proceso.
Para ellos se generará una cadena concatenados los siguientes valores:

idCliente

tokenFactura

Clave Privada

Sobre esta cadena, aplicaremos una función SHA 256 y el resultado será codificado en una cadena hexadecimal (en Mayúsculas):

firma = upper(hex(sha256(cadena de firma)))

Ejemplo de petición

Ejecutamos el método addDoc mediante una invocación POST al servicio en el entorno de test:

Con el siguiente cuerpo:

				
					{
 "idCliente": "bb9e34635fb7", 
 "tokenPago": "AD1064935F76441A828A9AA89",
 "receipt": 
{ 
"nombreDoc":"test.pdf", 
"contenidoDoc":"JVBERi0……", 
"mimeType":"application/pdf"
 }, 
 "firma": "0D2722AB7BD9365A83A792F3DC4F4B7B114ABA1A22A86448F56D16635556A097"
} 
				
			

El campo firma se ha compuesto de la siguiente manera:

Creamos la cadena de firma:
0D2722AB7BD9365A83A792F3DC4F4B7B114ABA1A22A86448F56D16635556A097

Generamos el hash para esa cadena, lo convertimos a una cadena hexadecimal y lo
ponemos en mayúsculas:
0D2722AB7BD9365A83A792F3DC4F4B7B114ABA1A22A86448F56D16635556A097

Respuesta a una petición
La petición anterior devolverá una respuesta JSON con el siguiente contenido:

Correcta
				
					{ 
 "resultado": "OK", 
 "sobrescrita": false, 
 "error": 0, 
 "idFactura":"F0125", 
 "tokenFactura":"A19E6E9C1C80400DA802A3E4FF74923148620EE6068A41BAA13FAC674A6B458E",
 "mensaje": "" 
} 

				
			

Con error 

				
					{ 
 "resultado": "KO", 
 "sobrescrita": false, 
 "error": 4 (Código de error correspondiente), 
 "idFactura":"", 
 "mensaje": "" 
} 
				
			
CONTENTS
en_GBEnglish (UK)