Consulta y recuperación de documentos
Reachcore ofrece la consulta y descarga de comprobantes y archivos que son resultado del procesamiento de los diferentes servicios que ofrece, por medio de un API REST.
Contenido
- Características generales
- Ubicación del servicio
- Autenticación
-
Operaciones
- Timbrado comprobantes
- Validación comprobantes
- Firma electrónica
- Códigos de respuesta
- Tipo de contenido
Características generales
El API Rest tiene el objetivo de poder recuperar los comprobantes que han sido procesados en Reachcore. Se podrán recuperar los XML asi como la representación impresa (PDF) de los CFDI (versión 3.2, 3.3 y 4.0), Comprobantes de Retenciones que han sido emitidos en Reachcore; adicionalmente también se pueden recuperar los comprobantes que se han enviado al servicio de validación, junto con la representación impresa correspondiente.
En el servicio de timbrado, se tiene la funcionalidad de poder generar una representación impresa conforme las necesidades del emisor. Para poder obtener la representación impresa del CFDI timbrado, debe tener activado dicho servicio; la recuperación se hace por medio de este servicio.
¿Qué necesito?
Para poder hacer uso del servicio se necesita lo siguiente:
- Utilizar los servicios con Reachcore.
- Haber generado un API Key en tu cuenta Reachcore, ya que es el un identificador que te autentica en el API REST.
- Poder invocar un Web Service, publicado en internet con conexión segura (SSL).
- Hacer la consulta a los servicios REST de Reachcore utilizando el método
GET.
Ubicación del servicio
El API REST se localiza en las siguientes URLs para cada uno de los ambientes:
| Ambiente | URL |
|---|---|
| Piloto | https://oat.reachcore.com/api/rest |
| Producción | https://go.reachcore.com/api/rest |
Autenticación
Para realizar la autenticación con el servicio API REST, es requerido incluir en el encabezado de la solicitud HTTP el parámetro RCApiKey, indicando el valor del API Key que fue generado en la plataforma de Reachcore.
Operaciones
Las operaciones que el API REST de Reachcore se describen a continuación. Se resalta el valor que es necesario para realizar la solicitud.
1. Servicio de timbrado y emisión
Las siguientes operaciones se relacionan con los comprobantes fiscales que han sido timbrado y emitido en Reachcore:
Comprobantes fiscales digitales por Internet (CFDI).
| Acción | Método | Descripción |
|---|---|---|
| Recuperar por UUID | Timbre/Get?uuid={uuid}&format={format} |
Permite la recuperación de un CFDI en XML o PDF en base el UUID. De forma predeterminada es xml; para obtener la representación impresa, enviar pdf |
| Recuperar por RFC, serie y folio | Timbre/Get?rfcEmisor={rfcEmisor}&serie={serie}&folio={folio}&format={format} |
Permite la recuperación del CFDI mediante el RFC del Emisor, la serie y folio. De forma predeterminada es xml; para obtener la representación impresa, enviar pdf |
| Recuperar metadatos | Timbre/timbredata?uuid={uuid} |
Permite la recuperación de los metadatos más relevantes de una transacción de timbrado de un CFDI. La respuesta es en formato JSON. |
Documento Electrónico que ampara Retenciones e Información de Pagos.
| Acción | Método | Descripción |
|---|---|---|
| Recuperar por UUID | Timbre/Retenciones?uuid={uuid}&format={format} |
Permite la recuperación de un documento electrónico en XML o PDF por UUID. De forma predeterminada es xml; para obtener la representación impresa, enviar pdf |
| Recuperar por RFC y folio | Timbre/Retenciones?rfcEmisor={rfcEmisor}&folio={folio}&format={format} |
Permite la recuperación del documento electrónico mediante el RFC del Emisor y folio. De forma predeterminada es xml; para obtener la representación impresa, enviar pdf |
2. Servicio de validación de comprobantes fiscales
Las siguientes operaciones son utilizados para obtener los documentos relacionados con el servicio de validación de comprobantes fiscales.
| Acción | Método | Descripción |
|---|---|---|
| Obtener representación impresa de comprobante validado | DocumentValidation/Transactions/{trackingId}/pdf |
Método de recuperación para la representación impresa del expediente de validación. |
| Recuperar comprobante validado | DocumentValidation/Transactions/{trackingId}/original |
Método de recuperación del archivo fuente que fue utilizado en el proceso de validación. |
| Recuperar documento original | Nom151/Transactions/{trackingId}/original |
Método de recuperación del documento fuente que se utilizó para generar una constancia NOM151. |
| Recuperar constancia de estampado de tiempo (Si esta configurado) | DocumentValidation/Transactions/{trackingId}/timestamp |
Método de recuperación del timestamp que respalda un documento validado correctamente. |
| Constancia NOM-151 (Si esta configurado) | Nom151/Transactions/{trackingId}/constancia |
Método de recuperación de una constancia NOM151. |
3. Servicio de firma electrónica
Las siguientes operaciones son para documentos que fueron procesados en el servicio de firma electrónica.
| Acción | Método | Descripción |
|---|---|---|
| Recuperar archivo original | Signature/Transactions/{transactionId}/original |
Método de recuperación del archivo XML original, antes de ser firmado electrónicamente. |
| Obtener PDF | Signature/Transactions/{transactionId}/pdf |
Método de recuperación del PDF, que representa la información contenida en el XML firmado electrónicamente. |
Códigos de respuesta
Como respuesta del servicio REST, obtendrá un código indicando el resultado de la operación.
| Código | Significado en HTTP 1.1 | Operación Exitosa | Significado |
|---|---|---|---|
| 200 | OK | Si | El comprobante pudo ser recuperado El XML del CFDI con content-type: application/xml |
| 401 | Unauthorized | No | El API Key de autenticación no es válida. Mensaje de error indicando que la autenticación no fue exitosa. |
| 404 | Not Found | No | No hay un comprobante que concuerde con los criterios especificados (rfcEmisor, serie, folio) Mensaje de error indicando que el comprobante no pudo ser encontrado. |
| 500 | Internal Server Error | No | Error de la plataforma Reachore Mensaje de error indicando la causa del 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 comprobante fiscal o acuse del SAT para CFDI | .xml |
application/pdf |
Archivo PDF de representación impresa del documento fiscal | |
application/json |
Archivo JSON del acuse del SAT para el documento electrónico de retenciones, metadatos del CFDI validado | .json |
application/timestamp-reply |
Timestamp RFC 3161 (ASN.1 codificado como DER) | .tsr |
application/pkcs7-mime |
Constancia NOM-151-SCFI-2002 (ASN.1 Codificado como DER) | .cns |
text/plain |
No se encontró archivo para su descarga | .txt |
Para mayor información o aclaración de dudas relacionadas con esta guía, por favor envía un correo a MEX-soporte@sovos.com
Regresar