Configuración y uso de Webconnector

Seguir

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 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, su asesor de soporte le proporcionara esta clave.
4. client_secret – ID secreto que corresponde a su RFC, su asesor de soporte le proporcionara esta clave.
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://auth.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://core.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:

{"emisor": {"rfc": "GOYA780416GM0", "nombre": "EMPRESA DE DEMOSTRACION S.A. DE C.V.", "regimenFiscal": "612", "descripcionFacturador": "Personas Físicas con Actividades Empresariales y Profesionales",

"sucursal": {"nombre": "Atizapán", "pais": "MEX", "estado": "Edo. de México", "municipio": "Atizapán de Zaragoza", "localidad": "", "colonia": "México Nuevo", "calle": "Veracruz", "noExterior": "34", "noInterior": "20", "referencia": "", codigoPostal": "51907", "descripcionColonia": "", "descripcionLocalidad": "", "descripcionMunicipio": "", "descripcionEstado": "", "descripcionPais": "", "correo": " contacto@facturador.com "}},

"receptor": { "rfc": "XAXX010101000", "nombre": "EMPRESA DE PRUEBA TALLER 24", "usoCFDI": "G03", "descripcionFacturador": "Gastos en general", "direccionIDFacturador": 0,

"direccion": { "nombre": "Principal", "pais": "", "estado": "", "municipio": "", "localidad": "", "colonia": "", calle": "", "noExterior": "", "noInterior": "", "referencia": "", "codigoPostal": "77500", "descripcionColonia": "", "descripcionLocalidad": "", "descripcionMunicipio": "", descripcionEstado": "", "descripcionPais": "", "correo": “contacto@facturador.com" }, "descripcionResidenciaFiscal": "" },

"conceptos": [ { "impuestos": { "traslados": [ { "base": 9000, "impuesto": "002", "tipoFactor": "Tasa", "tasaOCuota": 0.160000, "importe": 1440, "descripcionFacturador": "", "esExento": false } ], "retenciones": null }, "claveProdServ": "10101502", "noIdentificacion": "1", "cantidad": 100, "claveUnidad": "14", "unidad": "Shot", "descripcion": "NOTAS DE VENTA FOLIOS", "valorUnitario": 90, "importe": 9000, "descuento": 0, "claveFacturador": 0, "descripcionFacturador": "", "descripcionSat": "", "complementoIds": [], "idConcepto": 0 } ],

"impuestos": { "retenciones": null, "traslados": [ { "impuesto": "002", "tipoFactor": "Tasa", "tasaOCuota": 0.160000, "importe": 1440 } ], "totalImpuestosRetenidos": 0, "totalImpuestosTrasladados": 1440 }, "version": "3.3", "serie": "Sin serie", "folio": "806", "fecha": "2017-11-16T12:25:18", "sello": "", "formaPago": "99", "noCertificado": "20001000000200000216", "certificado": "", "subTotal": 9000, "descuento": 0, "moneda": "MXN", "tipoCambio": 1, "total": 10440.00, "tipoDeComprobante": "I", "metodoPago": "PPD", "lugarExpedicion": "77500", "informacionExtra": null, "complementoIds": [ 0 ], "estatusComprobante": 1, "descripcionFacturador": "Factura", descripcionMetodoPago": "", "descripcionFormaPago": "", "descripcionMoneda": "", "descripcionTipoConfirmacion": "" }

 

NOTA: Debido a que es un CFDI con complemento de pago, el valor del campo “metodoPago” debe ser “PPD”.

 

 

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://core.stagefacturador.com/businessEmision/api/v1/emisores/EmisorID/comprobantes?emitir=false

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 DE DEMOSTRACION S.A. DE C.V.", "regimenFiscal": "612", descripcionFacturador": "Personas Físicas con Actividades Empresariales y Profesionales", "sucursal": { "nombre": "Atizapán", "calle": "Veracruz", "codigoPostal": "51907", "colonia": "México Nuevo", "estado": "ROO", localidad": "01", "municipio": "Atizapán de Zaragoza", "noExterior": "34", "noInterior": "20", "pais": "MEX", "referencia": "" } },

"receptor": { rfc": "LAN7008173R5", "nombre": "EMPRESA DE PRUEBA TALLER 24", "usoCFDI": "G03", "descripcionFacturador": "Gastos en general", "direccionIDFacturador": 0, "direccion": { "nombre": "Principal", "pais": "", "estado": "", "municipio": "", "localidad": "", "colonia": "", "calle": "", "noExterior": "", "noInterior": "", "referencia": "", "codigoPostal":"77500", "correo": "miguelito@dsicsd.com" },"descripcionResidenciaFiscal": "" },

"conceptos": [ { "claveProdServ": "84111506", "cantidad": 1, "claveUnidad": "ACT", "descripcion":"Pago", "valorUnitario": 0, "importe": 0 } ],

"serie": "Sin serie", "serieid" : "1320325", folio": "807", "fecha": "2017-11-22T17:42:09", sello": "", noCertificado": "", "certificado": "", "subTotal": 0, "descuento": 0, total": 0, "estatusComprobante": 1, "version": "3.3", "moneda": "XXX", "tipoDeComprobante": "P", "lugarexpedicion" : "20001" }

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

Una vez obtenido el ID del complemento de pago, debemos vincularlo al CFDI padre por medio de 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 IdComprobante de su Complemento de pagos:

https://core.stagefacturador.com/businessEmision/api/v1/emisores/EmisorID/comprobantes/idComprobante/complementodepago

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 con los datos del comprobante padre y posteriormente dar click al botón “Enviar / Send”.

Ejemplo en formato JSON de la cadena que contendrá los datos del complemento de pagos con la información del CFDI padre:

{ "pago": [ { fechaPago": "22/11/2017", "formaDePagoP": "01", "monedaP": "MXN", "monto":"15",
"doctoRelacionado": [ { idDocumento": "355419D0-90EB-4E4A-8DAB-D91A72AB230A", "serie": "Sin serie", "folio": "807", "monedaDR": "MXN", "metodoDePagoDR": "PPD", "numParcialidad": "1", "impSaldoAnt": "10440.00", impPagado": "15.00", "impSaldoInsoluto": "10425.00" } ], "tipoCadenaPago": null } ], "version": "1.0" }

Una vez hecho esto ya habrá vinculado su complemento de pago a su CFDI, el último paso es emitirlo, para ello debe hacer nuevamente la solicitud mostrada en la pagina 13 con los datos del complemento de pagos.

Debe establecer el método PUT y hacer la solicitud a la siguiente URL sustituyendo el valor en rojo por el ID correspondiente a su RFC y el valor en verde por el IdComprobante correspondiente al complemento de pagos que creo anteriormente:

https://core.stagefacturador.com/businessEmision/api/v1/emisores/EmisorID/comprobantes/12999?emitir=true

NOTA: El parámetro en color morado indica que en esta ocasión el comprobante será timbrado.

 

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://core.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://core.devfacturador.com/businessEmisionDev/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://core.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://core.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://core.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" } }

 

CANCELAR COMPROBANTE

1.- Establezca el método DELETE.

2.- Inserte la siguiente URL, reemplazando las secciones en color Rojo por sus valores correspondientes.

https://core.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.

Una vez que esta acción se a 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": "39FBA91C-12EF-40B5-88E3-39F8D8F15536"

}

¿Tiene más preguntas? Enviar una solicitud

Comentarios

Tecnología de Zendesk