Descripción de documento
En este documento se especifica cómo hacer uso de nuestra API y sus diferentes métodos, mismos que le serán de ayuda para poder hacer uso de nuestro servicio WebConnector.
Requisitos
Postman: Le servirá para poder consumir nuestra API, puede descargar esta aplicación de la siguiente URL:
https://www.getpostman.com/
RFC de su cuenta en Facturador.com
Contraseña correspondiente a su Usuario (RFC de su cuenta) para WebConnector encriptada en MD5.
Ambiente de pruebas
Descripción de campos
Datos brindados por facturador ejemplo:
1. Password – Contraseña encriptada en MD5.
2. Username – RFC de su cuenta.
3. client_id – Este dato varía dependiendo del Ambiente (Pruebas o Producción) con el que esté trabajando. Para mas información consultar el siguiente enlace Crear cliente web api
4. client_secret – ID secreto que corresponde a su RFC. Para mas información consultar el siguiente enlace Crear cliente web api
5. es_md5 – Específica cuando la contraseña se encuentra en formato en MD5.
6. access_token – Token de acceso para consumir WebConnector.
7. refresh_token – Id correspondiente a su access_token.
8. expires_in – Especifica el tiempo de vida de su access_token.
Obtener token de acceso
Para generar su token de acceso primero debe hacer un request a través de Postman configurándolo de la siguiente forma:
1.- Establezca el método POST.
2.- Inserte la URL del ambiente que utilice (Pruebas o produccion).
3.- Posiciónese en el apartado “Headers”.
4.- Introduzca en el campo Key el texto: “Content-Type” y en el campo Value el texto “application/x-www-form-urlencoded”
5.- Posiciónese en el apartado Body.
6.- Seleccione la opción Raw.
7.- En el cuadro de texto de la parte inferior debe ingresar la siguiente cadena de texto, reemplazando los valores que se muestran en rojo por los correspondientes a su cuenta:
grant_type=password&scope=offline_access+openid+APINegocios+&username=RFCdeSuCuenta&password=SuContraseñaEncriptadaEnMD5&client_id=IdCorrespondienteAAmbiente&client_secret=SuClientSecret&es_md5=true
Cadena demostración para usar el método Obtener Token:
grant_type=password&scope=offline_access+openid+APINegocios+&username=AAB010101000&password=20b03da6247eb1ba4a04c3bda7285c94&client_id=webconector1&client_secret=D2EBED43-3DAD-48E8-906A-1B2221C63062&es_md5=true
Posteriormente debe dar click al botón “Enviar / Send”, si los datos enviados son correctos recibirá una respuesta de la API en la cual podrá ver su “Access_token”.
Actualizar Token
Su token tiene un tiempo de vida y una vez que ha expirado debe actualizarlo, para hacerlo puede volver a ejecutar el método anterior, o bien, usar el método “Refresh Token” sin necesidad de un usuario y contraseña.
Para actualizar su token por medio del método “Refresh Token” debe enviar un request a nuestra API por medio de Postman de la siguiente forma:
1.- Establecer el método POST.
2.- Inserte la URL del ambiente que utilice (Pruebas o produccion).
3.- Posicionarse en el apartado de “Headers”.
Introduzca en el campo Key el texto: “Content-Type” y en el campo Value el texto “application/x-www-form-urlencoded”.
5.- Por último, en el apartado “Body”, seleccionar la opción Raw y en el cuadro de texto ingresar la siguiente cadena de texto reemplazando los valores que se muestran en rojo por los correspondientes a su cuenta:
grant_type=refresh_token&refresh_token=SuRefreshToken&client_id=IdCorrespondienteAAmbiente&client_secret=SuClientSecret
Cadena demostración para usar el método Refresh Token:
grant_type=refresh_token&refresh_token=574b6dc3c05f22d09b44f5fe011852e1&client_id=webconector&client_secret=09EDA1E6-0F5D-4BC8-9AD7-C191DAC3B786
Si los datos son correctos recibirá su nuevo token actualizado.
OBTENER ID DEL EMISOR
Para obtener el ID del RFC y usuario de su cuenta en Facturador.com debe hacer un request a nuestra API de la siguiente forma:
1.- Establezca el método GET.
2.- Inserte la siguiente URL: https://authcli.stagefacturador.com/connect/userinfo
3.- Posiciónese en el apartado “Headers”.
4.- Introduzca en el campo Key el texto “Content-Type” y en el campo Value el texto “application/json”.
5.- Agregando otra configuración introduzca en el campo Key el texto “Authorization” y en el campo Value el texto: La palabra Bearer, seguido de un espacio en blanco, y por ultimo colocar la cadena de texto correspondiente a su access_token.
Posteriormente debe dar click al botón “Enviar / Send”, si los datos enviados son correctos recibirá una respuesta de la API en la cual podrá ver los datos correspondientes a su RFC.
GENERAR COMPROBANTE
Para generar un comprobante se utilizan los datos obtenidos en las secciones anteriores de este documento.
Al crear comprobantes se puede elegir entre emitirlos en el momento o guardarlos para emitirlos posteriormente, para esto se deberá especificar el parámetro “emitir” de la URL en true o false.
El resultado de esta solicitud a la API es un CFDI sellado y timbrado que puede ser visualizado en su plataforma web.
Para generar un comprobante debe hacer un request a nuestra API de la siguiente forma:
1.- Establezca el método POST.
2.- Inserte la siguiente URL, reemplazando el valor en Rojo por el ID correspondiente a su RFC: https://pruebas.stagefacturador.com/businessEmision/api/v1/emisores/EmisorID/comprobantes?emitir=true
3.- Posiciónese en el apartado “Headers”.
4.- Introduzca en el campo Key el texto “Content-Type” y en el campo Value el texto “application/json”.
5.- Agregando otra configuración introduzca en el campo Key el texto “Authorization” y en el campo Value el texto: La palabra Bearer, seguido de un espacio en blanco, y por ultimo colocar la cadena de texto correspondiente a su access_token.
6.- Ir al apartado Body.
7.- Seleccione la opción Raw.
8.- Despliegue la lista y seleccione la opción “JSON (application/json)”
9.- En el cuadro de texto inferior debe ingresar una cadena en formato Json con los datos del CFDI a timbrar y posteriormente dar click al botón “Enviar / Send”.
Ejemplo en formato JSON de la cadena que contendrá los datos del comprobante que quiere timbrar:
NOTA: Debido a que es un CFDI con complemento de pago, el valor del campo “metodoPago” debe ser “PPD”.
La sucursal del emisor como todos su atributos y Dirección del receptor y todos sus atributos son valores opcionales, por lo que pueden ir o no todo depende de la necesidad del cliente.
En caso de que la solicitud sea valida, la API devolverá el siguiente mensaje:
EsValido: Indica si el comprobante fue Timbrado correctamente.
IdComprobante: ID del CFDI en la base de datos de Facturador
Errores: Indicara los errores existentes.
UUID: Identificador único del CFDI
En caso de obtener errores, estos se mostraran en la sección de “Errores”, de igual forma el campo “IdComprobante” podrá tener un valor diferente a 0, en tal caso quiere decir que el CFDI no fue timbrado, pero fue guardado en la plataforma web para solucionar los errores y timbrarlo posteriormente.
Nota: En caso de que intente enviar a timbrar el mismo CFDI con los errores previamente solucionados, debe cambiar el metodo POST por el metodo PUT, de lo contrario se creara un nuevo registro en la plataforma web y el comprobante con errores registrado con errores previamente en la plataforma web seguirá ahí con un estatus Pendiente.
GENERAR COMPROBANTE CON COMPLEMENTO DE PAGO
Para generar un comprobante con complemento de pagos debe hacer una solicitud a nuestra API de la siguiente forma:
NOTA: Debe contar con el UUID de su CFDI Padre.
1.- Establezca el método POST.
2.- Inserte la siguiente URL, reemplazando el valor en color Rojo por el ID correspondiente a su RFC: https://pruebas.stagefacturador.com/businessEmision/api/v1/emisores/EmisorID/comprobantes?emitir=true
3.- Posiciónese en el apartado “Headers”.
4.- Introduzca en el campo Key el texto “Content-Type” y en el campo Value el texto “application/json”.
5.- Agregando otra configuración introduzca en el campo Key el texto “Authorization” y en el campo Value el texto: La palabra Bearer, seguido de un espacio en blanco, y por ultimo colocar la cadena de texto correspondiente a su access_token.
6.- Ir al apartado Body.
7.- Seleccione la opción Raw.
8.- Despliegue la lista y seleccione la opción “JSON (application/json)”
9.- En el cuadro de texto inferior debe ingresar una cadena en formato Json con los datos del complemento de pagos y posteriormente dar click al botón “Enviar / Send”.
Ejemplo en formato JSON de la cadena que contendrá los datos del complemento de pagos que quiere crear:
"emisor":{"rfc":"GOYA780416GM0","nombre":"Empresa Demo LAN","regimenFiscal":"612","claveFacturador":null,"descripcionFacturador":"General de Ley Personas Morales","sucursal":{"nombre":"Cancun","calle":"Bosque verde","codigoPostal":"77500","colonia":"0168","estado":"ROO","localidad":"01","municipio":"001","noExterior":"2","noInterior":null,"pais":"MEX","referencia":null},"sucursalId":"48781"},"receptor":{"rfc":"LAN7008173R5","nombre":"QUEBRANDO","numRegIdTrib":null,"usoCFDI":"P01","claveFacturador":null,"descripcionFacturador":"Adquisición de mercancias","direccionIDFacturador":0,"clienteIDFacturador":3175629,"direccion":{"nombre":"Principal","pais":"a","estado":"a","municipio":"a","localidad":"a","colonia":"a","calle":"a","noExterior":"a","noInterior":"a","referencia":"referencia","codigoPostal":"00000","descripcionColonia":"","descripcionLocalidad":"","descripcionMunicipio":"","descripcionEstado":"","descripcionPais":"","correo":"auicab@facturador.com"},"descripcionResidenciaFiscal":null},"conceptos":[{"claveProdServ":"84111506","cantidad":1,"claveUnidad":"ACT","descripcion":"Pago","valorUnitario":0,"importe":0}],"complemento":[{"complementoPago":{"pago":[{"doctoRelacionado":[{"idDocumento":"4D654B6C-43DA-4181-ABE5-C6D734392D0B","impPagado":10.00}],"fechaPago":"2018-05-01T00:00:00","formaDePagoP":"02","monedaP":"MXN","monto":10440.00,"numOperacion":"7","rfcEmisorCtaOrd":"XEXX010101000","nomBancoOrdExt":"Banamex","ctaOrdenante":"123123123123123123","rfcEmisorCtaBen":"LAN7008173R5","ctaBeneficiario":"7123333333"}],"version":"1.0"}}],"serie":"Sin Serie","serieId":1283650,"folio":"101","fecha":"2018-03-21T12:31:14","sello":"","noCertificado":"","certificado":"","subTotal":0,"descuento":0,"total":0,"estatusComprobante":1,"version":"3.3","moneda":"XXX","tipoDeComprobante":"P","idFacturador":16,"lugarExpedicion":"77500"}
En caso de que la solicitud sea valida, la API devolverá el siguiente mensaje:
CONSULTAR UN COMPROBANTE
En caso de querer consultar un CFDI debe hacer una solicitud a nuestra API de la siguiente forma:
1.- Establezca el método GET.
2.- Inserte la siguiente URL, reemplazando el valor en color Rojo por el ID correspondiente a su RFC y el valor en color verde por el UUID de su CFDI: https://pruebas.stagefacturador.com/businessEmision/api/v1/emisores/EmisorID/comprobantes/UUID
3.- Posiciónese en el apartado “Headers”.
4.- Introduzca en el campo Key el texto “Content-Type” y en el campo Value el texto “application/json”.
5.- Agregando otra configuración introduzca en el campo Key el texto “Authorization” y en el campo Value el texto: La palabra Bearer, seguido de un espacio en blanco, y por ultimo colocar la cadena de texto correspondiente a su access_token.
6.- Dar click en el botón “Enviar / Send”.
Si los datos son correctos recibira una respuesta con su CFDI en formato Json.
OBTENER XML/PDF
En caso de querer obtener un CFDI en su formato Xml debe hacer una solicitud a nuestra API de la siguiente forma:
1.- Establezca el método GET.
2.- Inserte la siguiente URL, reemplazando el valor en color Rojo por el ID correspondiente a su RFC y el valor en color verde por el UUID de su CFDI:
https://pruebas.stagefacturador.com/businessEmision/api/v1/emisores/EmisorID/descargacomprobantes/UUID?tipoContenido=xml
En el parámetro color Naranja puede indicar el valor “Xml” o “pdf” según el archivo que quiera obtener.
3.- Posiciónese en el apartado “Headers”.
4.- Introduzca en el campo Key el texto “Content-Type” y en el campo Value el texto “application/json”.
5.- Agregando otra configuración introduzca en el campo Key el texto “Authorization” y en el campo Value el texto: La palabra Bearer, seguido de un espacio en blanco, y por ultimo colocar la cadena de texto correspondiente a su access_token.
6.- Dar click en el botón “Enviar / Send”.
GENERAR PDF
En caso de querer generar un PDF correspondiente a un CFDI debe hacer una solicitud a nuestra API de la siguiente forma:
1.- Establezca el método POST.
2.- Inserte la siguiente URL, reemplazando el valor en color Rojo por el ID correspondiente a su RFC y el valor en color verde por el UUID de su CFDI:
https://pruebas.stagefacturador.com/businessEmision/api/v1/emisores/EmisorId /pdfs/UUID
3.- Posiciónese en el apartado “Headers”.
4.- Introduzca en el campo Key el texto “Authorization” y en el campo Value el texto: La palabra Bearer, seguido de un espacio en blanco, y por ultimo colocar la cadena de texto correspondiente a su access_token.
5.- Dar click en el botón “Enviar / Send”.
OBTENER URL PARA DESCARGA DE PDF
Una vez realizado el método anterior puede obtener una URL para realizar la descarga de su PDF a través de cualquier navegador, para ello debe hacer una solicitud a nuestra API de la siguiente forma:
1.- Inserte la siguiente URL, reemplazando el valor en color Rojo por el ID correspondiente a su RFC y el valor en color verde por el UUID de su CFDI:
https://pruebas.stagefacturador.com/businessEmision/api/v1/emisores/EmisorID/comprobantes/UUID/pdf
2.- Establezca el método GET.
3.- De click en la sección “Authorization”, en el campo Type seleccione “Bearer Token”.
4.- En el campo “Token” agregue el valor de su “Access Token”.
5.- De click en la sección “Headers”.
6.- Introduzca en el campo Key el texto “Content-Type” y en el campo Value el texto “application/x-www-form-urlencoded”.
7.- De click al botón “Send / Enviar”.
Si los datos enviados son correctos obtendrá en la respuesta una URL que puede ingresar en cualquier navegador para descargar su archivo Pdf.
ENVIAR CORREO
En caso de querer consultar un CFDI debe hacer una solicitud a nuestra API de la siguiente forma:
1.- Establezca el método POST.
2.- Inserte la siguiente URL, reemplazando el valor en color Rojo por el ID correspondiente a su RFC:
https://pruebas.stagefacturador.com/BusinessEmision/api/v1/emisores/IdEmisor/enviocorreo
3.- Posiciónese en el apartado “Headers”.
4.- Introduzca en el campo Key el texto “Content-Type” y en el campo Value el texto “application/json”.
5.- Agregando otra configuración introduzca en el campo Key el texto “Authorization” y en el campo Value el texto: La palabra Bearer, seguido de un espacio en blanco, y por ultimo colocar la cadena de texto correspondiente a su access_token.
6.- Ir al apartado Body.
7.- Seleccione la opción
8.- Despliegue la lista y seleccione la opción “JSON (application/json)”
9.- En el cuadro de texto inferior debe ingresar una cadena en formato Json con los datos del complemento de pagos con los datos del comprobante padre y posteriormente dar click al botón “Enviar / Send”.
Si los datos son correctos recibirá un “True” como respuesta indicando que el correo fue enviado.
Ejemplo en formato JSON de la cadena que contendrá los datos del envío de correo:
{ "asunto": "Tu comprobante Fiscal Digital con la nueva versión 3.3", "cc": "", "mensaje": "hola", "para": "ejemplo@mail.com.mx", "responderA": " ejemplo@mail.com.mx ", "cfdi": { "seleccionado": false, "fecha": "2017-11-22T15:41:18.000Z", "uuid": "F58D7309-E86D-408F-8073-9F88163E0D25", "total": 0, "receptorNombre": "EMPRESA DE PRUEBA 99", "serie": "alvapagos", "folio": "99", "idResumenComprobante": 82656, "receptorRfc": "ROB3078173Y4", "satTipoDeComprobante": "P" } }
BUSQUEDA DE COMPROBANTES
En caso de querer obtener el listado de sus comprobantes emitidos por su emisor debe hacer una solicitud a nuestra API de la siguiente forma:
1.- Establezca el método GET.
2.- Inserte la siguiente URL, reemplazando el valor en color Rojo por el ID correspondiente a su RFC y el valor en color verde las fecha inicial y final de su búsqueda:
NOTA: El formato fecha soportado por el servicio es Unix time stamp.
Puede consultar la siguiente URL para obtener el formato indicado de la fecha https://www.unixtimestamp.com/
3.- Posiciónese en el apartado “Headers”.
4.- Introduzca en el campo Key el texto “Connection” y en el campo Value el texto “keep-alive”. Añada otro registro introduciendo en el campo Key el texto “Accept” y en el campo Value el texto “application/json, text/plain, */* ”.
5.- Agregando otra configuración introduzca en el campo Key el texto “Authorization” y en el campo Value el texto: La palabra Bearer, seguido de un espacio en blanco, y por último colocar la cadena de texto correspondiente a su access_token.
6.- Dar click en el botón “Enviar / Send”.
CANCELAR COMPROBANTE
Cancelación Directa.
Este comprobante no requiere de la autorización del receptor, se cancela en automático sin necesidad de esperar autorización.
Reglas para una cancelación directa.
Fuente: sat.gob.mx
1.- Establezca el método DELETE.
2.- Inserte la siguiente URL, reemplazando las secciones en color Rojo por sus valores correspondientes.
https://pruebas.stagefacturador.com/BusinessEmision/api/v1/emisores/idEmisor/comprobantes/uuid
3.- Posiciónese en el apartado “Headers”.
4.- Agregando otra configuración introduzca en el campo Key el texto “Authorization” y en el campo Value el texto: La palabra Bearer, seguido de un espacio en blanco, y por último colocar la cadena de texto correspondiente a su access_token.
La sección esValido = true indica que la solicitud se realizó satisfactoriamente.
El atributo “SubEstatusId” y “descripción” indican el estado del comprobante, en este caso es un comprobante menor de $5000.00 pesos por lo que la cancelación es directa, este no pasa por la autorización del receptor.
Una vez que esta acción se ha hecho con un comprobante no se podrá volver a realizar, si se vuelve a intentar la API responderá con el siguiente error.
{
"esValido": false,
"idComprobante": 0,
"errores": [
{
"codigo": "FAC106",
"mensaje": "El comprobante se encuentra cancelado"
}
],
"uuid": "D28932E6-5C31-44C0-90B1-A5AA72C18BC3"
"subEstatusId": 0,
"descripcion": null
}
Cancelación con Aceptación.
En caso de que el comprobante requiera de la aceptación del receptor le llega un aviso de interés por medio de su buzón tributario.
Solo se tendrán tres días hábiles partiendo desde que se recibió la solicitud de cancelación, para que el receptor autorice o no dicho movimiento, si el receptor no responde a esto transcurrido este tiempo, la autoridad fiscal dará por aceptada esta solicitud (es decir se cancelará automáticamente).
Si se solicita una segunda petición de cancelación, está ya no entra en el plazo de tres días, por default entra a “negativa ficta” y solo se podrá cancelar cuando el receptor acepte dicha solicitud.
No existe un máximo de peticiones de cancelación.
El requisito principal para que su comprobante requiera de la autorización del receptor es que sea con un total mayor a $5000.00
Cuando se envié a timbrar el comprobante hay que esperar 10-15 min para que este se pueda cancelar en pruebas hay que darle tiempo a la respuesta del SAT, para que este entre en el subEstatusId “4”
El “subEstatusId” y “descripción” indican que el comprobante esta como “Emitido (Espera Cancelación)” aquí el emisor tendrá que esperar a que su receptor de su respuesta ya sea desde su sistema propio con otro PAC, plataforma del SAT o desde Facturador.com (En caso de que este dado de alta con nosotros)
{
"esValido": true,
"idComprobante": 5503143,
"errores": [],
"uuid": "A25DA80E-2799-4D5F-8E02-146D9DF70BE8",
"subEstatusId": 4,
"descripcion": "Emitido (Espera Cancelación)"
}
Al Receptor le va a llegar la notificación de la solicitud de cancelación, aquí el emisor tendrá que esperar a que su receptor conteste dicha solicitud.
La actualización de las respuestas se realizará todas las madrugadas, por lo que las respuestas de cancelación con Aceptación no son inmediatas, un comprobante puede llevar hasta dos días en regresar una respuesta.
Si el cliente intenta enviar nuevamente su comprobante a cancelar este regresa la siguiente repuesta, “El comprobante se encuentra en proceso de cancelación”, esto indica que el comprobante está en espera de respuesta por parte del receptor.
{
"esValido": false,
"idComprobante": 0,
"errores": [
{
"codigo": "FAC092",
"mensaje": "El comprobante se encuentra en proceso de cancelación."
}
],
"uuid": "A25DA80E-2799-4D5F-8E02-146D9DF70BE8",
"subEstatusId": 0,
"descripcion": null }
Cuando el receptor de una respuesta a la solicitud de cancelación y el emisor envié nuevamente a cancelar el comprobante recibirá el siguiente mensaje “El comprobante se encuentra cancelado”
A qui el emisor ya puede descargar su PDF Cancelado y acuse de cancelación, este último deberá descargarse desde la plataforma web.
PDF Cancelado con aceptación.
Acuse de cancelación.
NOTA: El ambiente de pruebas se encuentra activo en un horario de Lunes a Viernes de 9 am a 6 pm, en caso de requerir en otro horario o día, solicitar al área de soporte. El ambiente productivo está activo las 24/7 365 días del año.
Comentarios