API para integrarse con Archiving

Contenido

Características generales

Esta API permite realizar consultas en archiving sin necesidad de usar la interfaz gráfica. Esto permite integrar el motor de archiving a otros sistemas.

¿Qué necesito?

  • Tener activado el servicio de archiving en tu cuenta Reachcore.
  • Generar un API Key en tu cuenta Reachcore, ya que se usa para autenticar la solicitud en el API Rest. El API Key debe corresponder al ambiente en el que se realiza la solicitud. Para referencia de cómo generar el API Key, consulta el siguiente artículo: Generar API Key para Web Services.

Ubicación del servicio

Ambiente URL
Piloto https://oat.archiving.reachcore.com/api
Producción https://go.archiving.reachcore.com/api


Todas las solicitudes se deberán hacer por el canal de comunicación seguro (https). Las conexiones realizadas por http serán rechazadas

Verbo HTTP: GET

Comprobar funcionalidad del servicio

Es posible comprobar si el servicio de archiving está en línea por medio de un healthcheck. Para llevar a cabo esta validación se requiere de emplear la operación monitoring/healthcheck. El resultado es un código HTTP 200 si el servicio se encuentra operando. Este método no requiere de autenticación por medio de APIKEY. Puedes encontrar los códigos HTTP que usa el servicio en la sección de Códigos de respuesta HTTP

Operaciones

Las operaciones que el API de Archiving se describen a continuación. Se resalta el valor que es necesario para realizar la solicitud.

Todas las operaciones requieren de autenticación por medio de ApiKey en el header de la petición por medio del identificador RCApiKey
Acción Método Descripción
Búsqueda de comprobantes comprobantes/search?rcql={cadena de búsqueda} Realiza una búsqueda de Comprobantes con el criterio especificado en {cadena de búsqueda}. El formato de {cadena de búsqueda} es el siguiente: {atributo a buscar}='{criterio de búsqueda}' donde un atributo a buscar puede ser cualquiera de los siguientes:
  • descuento
  • fechaEmision
  • fechaTimbrado
  • folio
  • folioFiscal
  • formaDePago
  • metodoDePago
  • moneda
  • rfcEmisor
  • rfcReceptor
  • serie
  • tipoComprobante
  • total
  • version

Se pueden combinar distintos {atributo a buscar} por medio de operadores and y or.
Por ejemplo, si se desea buscar los Comprobantes cuyo rfcEmisor es el 'AAA010101AAA' y la formaDePago es '99', se emplearía la siguiente cadena de búsqueda: {rfcEmisor='aaa010101aaa' and formaDePago='99'.}
Para las búsquedas por fecha se debe incluir un rango de valores {fechaEmision>=DD/MM/AAAA and fechaEmision<=DD/MM/AAAA} (Nota: Los valores del rango de fechas no van entre comillas), si tomamos el ejemplo anterior y utilizáramos el rango de fecha entre el 19 de julio del 2016 y el 20 de julio del 2017 la petición quedaría de la siguiente manera: {rfcEmisor='aaa010101aaa' and formaDePago='99' and fechaEmision>=19/07/2016 and fechaEmision<=20/07/2017.}

Se utiliza una paginación default para mostrar 100 registros, si se encuentra que el total es mayor a esta cantidad, ejemplo: "total": 244; se debe ampliar el rango en la petición de la siguiente manera {from=0 size=244} ; no excediendo el valor size de 9999
Descarga de comprobante comprobantes/download/{uuid}/{formato} Permite la recuperación de un Comprobante con base en su folio fiscal (UUID). En {formato} se esperan únicamente los valores xml o pdf.
Por ejemplo, para recuperar el XML del CFDI con UUID A1D9FF50-BB53-4BC9-9AE9-0203DC538BE0, se emplea la siguiente petición:
https://go.archiving.reachcore.com/api/comprobantes/download/A1D9FF50-BB53-4BC9-9AE9-0203DC538BE0/xml
Búsqueda de comprobantes validados
Nuevo
comprobantes/searchValidacion?rcql={cadena de búsqueda} Realiza una búsqueda de Comprobantes previamentes validados por Reachcore por medio del criterio especificado en {cadena de búsqueda}. El formato de {cadena de búsqueda} es el siguiente: {atributo a buscar}='{criterio de búsqueda}' donde un atributo a buscar puede ser cualquiera de los siguientes:
  • descuento
  • fechaEmision
  • fechaTimbrado
  • folio
  • folioFiscal
  • formaDePago
  • metodoDePago
  • moneda
  • rfcEmisor
  • rfcReceptor
  • serie
  • tipoComprobante
  • total
  • version

Se pueden combinar distintos {atributo a buscar} por medio de operadores and y or.
Por ejemplo, si se desea buscar los Comprobantes cuyo rfcEmisor es el 'AAA010101AAA' y la formaDePago es '99', se emplearía la siguiente cadena de búsqueda: {rfcEmisor='aaa010101aaa' and formaDePago='99'}
Descarga de comprobantes validados
Nuevo
comprobantes/downloadValidacion/{uuid}/{formato} Permite la recuperación de un Comprobante que ha sido validado previamente por Reachcore tomando como base su folio fiscal (UUID). En {formato} se esperan únicamente los valores xml o pdf.
Por ejemplo, para recuperar el XML del CFDI con UUID A1D9FF50-BB53-4BC9-9AE9-0203DC538BE0, se emplea la siguiente petición:
https://go.archiving.reachcore.com/api/comprobantes/downloadValidacion/A1D9FF50-BB53-4BC9-9AE9-0203DC538BE0/xml

Para poder hacer uso de la funcionalidad de búsqueda de comprobantes validados deberás contar con este servicio habilitado en tu cuenta. Para mayor información acerca de cómo contar con esta capacidad, por favor envía un correo a MEX-soporte@sovos.com
Archiving sólo almacena documentos con un folio fiscal como parte del complemento de Timbre Fiscal Digital. Dentro del almacen de archiving no se guardan documentos no fiscales que no tengan un UUID ya sea como parte de una operación de emisión, timbrado o de validación.

Códigos de respuesta HTTP

Código Singifica Descripción
200 Success Comunicación entre las partes establecida correctamente
401 Unauthorized No se está autorizado para ejecutar alguna acción del API (posiblemente falta el API KEY en el encabezado de la petición)
500 Internal Server Error Este es un error interno de Reachcore. Por favor notifica a Soporte Reachcore acerca de esta situación y proporciona el mayor detalle posible para poder reproducir este error.

Tipo de contenido

Los content type para cada tipo de archivo que se descarga son:

Content Type Contenido Extensión
application/xml Archivo XML del CFDI almacenado en archiving .xml
application/pdf Representación impresa del CFDI almacenado en archiving en formato PDF .pdf
application/json Archivo JSON con contenido de la búsqueda .json

El content type debe especificarse en el header de la petición.


Regresar