Consultas a servicios adicionales
Reachcore ha creado un API REST para la consulta de listas consultadas en el proceso de certificación de un CFDI:
- Lista de los RFC inscritos no cancelados
- Lista de Certificados de Sello Digital
Contenido
- ¿Qué necesito?
- Consulta a la lista de los RFC inscritos no cancelados
- Consulta a lista de Certificados de Sello DigitalActualizado
¿Qué necesito?
- Tener activado el servicio de consultas 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.
Consulta a la lista de los RFC inscritos no cancelados
En este recurso se podrán consultar hasta 100 RFC por solicitud. Para ello, se debe enviar al API REST lo siguiente:
Ambiente | URL |
---|---|
Piloto | https://oat.reachcore.com/api/rest/sat/rfcs |
Producción | https://go.reachcore.com/api/rest/sat/rfcs |
https
). Las conexiones realizadas por http
serán rechazadasVerbo HTTP: POST
Encabezado HTTP
Parámetro | Valor | Uso | Descripción |
---|---|---|---|
RCApiKey |
API Key | Requerido | Autenticación al servicio por medio del API Key generado en la plataforma de Reachcore. |
Content-Type |
application/json |
Requerido | El API Rest solo procesa estructuras JSON, por la cual se debe declarar. |
Cuerpo
Solo se acepta la estructura de un JSON en el cuerpo de la solicitud; se debe de enviar un conjunto de hasta 100 RFCs por solicitud, como se muestra a continuación:
Ejemplo de solicitud consulta RFC
{
"rfcs": [
"&AAR121024Q23",
"FAVJ770101UN1"
]
}
Códigos de respuesta
Como respuestá del servicio REST, obtendrá un código indicando el resultado de la operación. Todas las repuestás son en formato JSON (application/json
)
Código HTTP | Significado |
---|---|
200 | La consulta se realizó correctamente. |
401 | Unauthorized - El API Key no es válido. |
403 | Forbidden - Su cuenta no tiene los permisos para usar el servicio de consulta. Por favor contacte a MEX-soporte@sovos.com |
500 | Internal Server Error - Error de la plataforma Reachcore |
Ejemplo de respuestá con error 403
{
"errors": [
{
"Code": "403",
"Message": "La cuenta no se encuentra autorizada.Por favor revise que tenga la funcionalidad CONSULTA_PADRON_SAT_RFC activado"
}
]
}
Ejemplo de respuestá correcta de la consulta RFC
{
"queryDate": "2017-01-07T12:13:47",
"updated": "2017-01-13T00:00:00",
"results": [
{
"rfc": "&AAR121024Q23",
"exists": true,
"properties": {
"deleted": false,
"modified": "2016-12-28T00:00:00",
"subcontratacion": false,
"sncf": false
}
},
{
"rfc": "FAVJ770101UN1",
"exists": false
}
]
}
Descripción de la respuestá exitosa de consulta
Consulta a lista de Certificados de Sello Digital Actualizado
Se puede consultar hasta 100 números de serie de Certificados de Sello Digital por solicitud.
Ubicación
Ambiente | URL |
---|---|
Piloto | https://oat.reachcore.com/api/rest/sat/certificados |
Producción | https://go.reachcore.com/api/rest/sat/certificados |
https
). Las conexiones realizadas por http
serán rechazadasVerbo HTTP: POST
Encabezado HTTP
Parámetro | Valor | Uso | Descripción |
---|---|---|---|
RCApiKey |
API Key | Requerido | Autenticación al servicio por medio del API Key generado en la plataforma de Reachcore. |
Content-Type |
application/json |
Requerido | El API Rest solo procesa estructuras Json, por la cual se debe declarar. |
Cuerpo
Solo se acepta la estructura de un JSON en el cuerpo de la solicitud; se debe de enviar un conjunto de hasta 100 CSD (número de certificado) por solicitud, como se muestra a continuación:
Ejemplo de solicitud consulta CSD
{
"certificados": [
"20001000000100005704",
"20001000000100005867",
"40001000000100005811"
]
}
Códigos de respuestá
Como respuestá del servicio REST, se obtendrá un código indicando el resultado de la operación. Todas las repuestás son en formato JSON (application/json
)
Código HTTP | Significado |
---|---|
200 | La consulta se realizó correctamente. |
401 | Unauthorized - El API Key no es válido. |
403 | Forbidden - Su cuenta no tiene los permisos para usar el servicio de consulta. Por favor contacte a MEX-soporte@sovos.com |
500 | Internal Server Error - Error de la plataforma Reachcore |
Ejemplo de respuestá con error 401
{
"Message": "El ApiKey proporcionado es inválido.",
"Error": {
"Code": "401",
"Message": "El ApiKey proporcionado es inválido."
}
}
Ejemplo de respuestá correcta de la consulta CSD
{
"queryDate": "2019-01-14T15:44:49",
"updated": "2019-01-14T00:00:00",
"results": [
{
"numeroSerie": "20001000000100005704",
"exists": true,
"properties": {
"rfc": "AAA010101AAA",
"fechaInicio": "2012-06-26T23:00:25",
"fechaFinal": "2019-05-08T12:46:39",
"validezObligaciones": true,
"elegibleEstimuloIva": true,
"estatusCertificado": "A",
"active": true,
"modified": "2019-01-14T15:44:49"
}
},
{
"numeroSerie": "20001000000100005867",
"exists": true,
"properties": {
"rfc": "AAA010101AAA",
"fechaInicio": "2012-07-27T11:02:00",
"fechaFinal": "2019-05-08T12:46:39",
"validezObligaciones": true,
"elegibleEstimuloIva": false,
"estatusCertificado": "A",
"active": true,
"modified": "2019-01-14T15:44:49"
}
},
{
"numeroSerie": "40001000000100005811",
"exists": false
}
]
}
Descripción de la respuestá exitosa de consulta
Nombre | Valor |
---|---|
queryDate | Fecha en que se realizó la consulta. |
updated | Fecha en la que se actualizó la lista. |
Results | Arreglo que contiene el resultado de la consulta de los certificados. |
numeroSerie | El número de serie del certificado de sello digital. |
exists | Valor booleano que indica si el número de certificado está registrado en la lista. En caso de recibir el valor false , significa que el CSD nunca ha existido con el número de certificado reportado. |
properties | Se mostrarán las características del CSD consultado, cuando el valor en exists sea true . |
rfc | El RFC que está asociado al CSD. |
fechaInicio | Fecha de inicio de vigencia del CSD. |
fechaFinal | Fecha fin de vigencia del CSD. |
validezObligaciones | Indica si el número de certificado está autorizado por el SAT para emitir comprobantes. Posibles valores:false para indicar que tiene marca de Sin características para facturartrue para indicar que tiene marca de Habilitado para facturar (IVA exento, tasa 0% y 16%) |
elegibleEstimuloIva Nuevo |
Indica si el número de certificado está autorizado por el SAT para hacer uso del estímulo fiscal para la región fronteriza norte. Posibles valores:false para indicar que no está facultadotrue para indicar que tiene marca de Habilitado para facturar (IVA exento, tasa 0%, 8% y 16%) |
estátusCertificado | Estátus del certificado en la lista: C .- Caducado A .- Activo R .- Revocado |
active | Valor booleano que será true , cuando cumpla las siguientes condiciones:
|
modified | Fecha cuando se modificó el CSD por última vez |
Para mayor información o aclaración de dudas relacionadas con está guía, por favor envía un correo a MEX-soporte@sovos.com
Regresar