Documentación para integración con servicios Sovos
Inicio

API para incrementar/decrementar saldo de un RFC en el servicio de timbrado

Reachcore ha creado un API REST que te permite incrementar o decrementar el saldo de un RFC registrado en tu cuenta para el servicio web de Timbre:

Contenido

¿Qué necesito?

  • Tener activado el servicio de Timbre 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

En este recurso se podrá afectar (incrementar/decrementar) el saldo de cada uno de los RFC registrados en tu cuenta. Para ello, se debe enviar al API REST lo siguiente:

Ambiente URL
Piloto https://oat.reachcore.com/api/rest/timbre/asignacion/saldo
Producción https://go.reachcore.com/api/rest/timbre/asignacion/saldo


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

Afectar saldo de un RFC

Verbo 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

Atributo Tipo Descripción Validaciones sobre el atributo
RFC String RFC al que se le quiere modificar el saldo El RFC debe ser valido (contra estructura de un RFC según Anexo 20).
El RFC debe estar registrado en la cuenta (ya sea por emisión o timbrado)
Incrementar Numérico Cantidad de saldo a incrementar Sólo se permiten valores enteros. El valor ingresado en este parámetro debe ser mayor a cero y menor o igual que saldo-por-asignar
Decrementar Numérico Cantidad de saldo a decrementar Sólo se permiten valores enteros. El valor ingresado en este parámetro no puede ser negativo y no puede ser mayor al saldo actual para el RFC especificado

Ejemplo de solicitud incrementar saldo 

{
  "rfc" : "XAXX0101010000",
  "incrementar" : 1
}

Ejemplo de respuesta 

{
    "result": "El saldo fue afectado exitosamente.",
    "rfc": "XAXX0101010000",
    "saldo_disponible_rfc": "7",
    "saldo_por_asignar": "3"
}

Códigos de respuesta

Código HTTP Sub-código de error Significado Descripción
200 -- OK El saldo fue afectado exitosamente.
400 400-001 Bad request Sólo se debe especificar una operación: 'incrementar' o 'decrementar'
400 400-002 Bad request No puedes asignar mas transacciones de las que tienes por asignar en tu cuenta
400 400-003 Bad request No se pueden modificar transacciones con números negativos
401 -- Unauthorized El API Key no es válido.
404 -- Not found La URL especificada no existe
412 412-001 Precondition failed La cuenta RC no está configurada para timbrado
412 412-002 Precondition failed El RFC proporcionado no existe en tu cuenta Reachcore
500 -- Internal server error Error de la plataforma Reachore

Configurar notificaciones por correo

Descripción

Este método del API permite especificar un límite de transacciones por RFC para que cuando el saldo de ese RFC llegue a ese límite se envíe un correo electrónico a las direcciones especificadas.

Ambiente URL
Piloto https://oat.reachcore.com/api/rest/timbre/asignacion/AlertaSaldo
Producción https://go.reachcore.com/api/rest/timbre/asignacion/AlertaSaldo


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

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

Atributo Tipo Descripción Validaciones sobre el atributo
RFC String RFC al que se le quiere agregar la notificación El RFC debe ser valido (contra estructura de un RFC según Anexo 20).
El RFC debe estar registrado en la cuenta (ya sea por emisión o timbrado)
Limite Numérico Cantidad de transacciones a partir de las que se enviará notificación Debe ser un número entero positivo
Correo String Dirección o direcciones de correo (separadas por coma) a las que se enviará una notificación de saldo llegando a 'límite'. Se verifica que la dirección de correo proporcionada esté en un formato valido.
Apagar boolean Identificador que permite apagar una notificación de límite de saldo Valores permitidos: { "true", `"false" }

Si el atributo Apagar tiene un valor false o no se envía en la petición, los campos Limite y Correos son requeridos.

Ejemplo


  {
  "RFC" : "XAXX010101000",
  "Apagar": "false",
  "Limite" : "10",
  "Correos" : [
  		"abdul.alhazred@mail.com",
  		"howard.lovecraft@mail.com]
	}

Ejemplo de respuesta 


{
	"result": "El límite para notificación de correo del RFC XAXX010101000 fue afectado exitosamente."
}


Códigos de respuesta

Código HTTP Sub-código de error Significado Descripción
200 -- OK El límite para notificación de correo del RFC 'RFCProporcionado' fue establecido exitosamente
400 400-001 Bad request No se pueden agregar notificaciones con números negativos
400 400-002 Bad request El RFC proporcionado no tiene una estructura válida
400 400-003 Bad request La dirección de correo 'direccion@invalida' no parece ser una dirección de correo válida
400 400-004 Bad request Sólo se debe especificar un valor numérico en: 'limite'
400 400-005 Bad request Sólo se debe especificar un valor boleano en: 'apagar' true o false
400 400-006 Bad request El atributo 'limite es requerido'
400 400-007 Bad request La lista de 'correos' es requerida
401 -- Unauthorized El API Key no es válido.
404 -- Not Found La URL especificada no existe
412 412-001 Precondition Failed La cuenta RC no está configurada para timbrado
412 412-002 Precondition Failed El RFC proporcionado no existe en tu cuenta reachcore
412 412-003 Precondition Failed No se ha especificado un RFC al cual configurarle alertas de correo
500 -- Internal Server Error Error de la plataforma Reachore

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