SERVICIO API LISTAS NEGRAS SAT
Documentación Técnica
Llenar la información solicitada:
Es importante destacar que el correo electrónico debe ser institucional (en caso de que se trate de una persona moral).
En cuanto a Nombre y Apellidos tanto para personas físicas y morales recomendamos que se trate de un contacto técnico.
Una vez completada toda la información, el desarrollador recibirá un correo electrónico con una liga donde podrá darse de alta y comenzar el próximo paso que es la suscripción a los productos del API.
Cuando el desarrollador active su cuenta (haciendo clic sobre la liga enviada en el correo), recibirá otro correo con las siguientes características:
A partir de este momento estamos listos para suscribirnos al producto de Listas Negras del SAT publicado en nuestra API.
2.- SUSCRIPCIÓN AL PRODUCTO
En este segmento explicaremos como es el proceso de solicitud para poder utilizar específicamente el servicio de Listas Negras SAT.
En el menú superior seleccionamos PRODUCTS.
A continuación, entre los productos publicados debe aparecer BLACK LIST.
Al hacer clic sobre dicho producto, comienza el proceso de suscripción al mismo.
Es requisito indispensable que en el nombre de la suscripción se indique únicamente el RFC del cliente que está solicitando dicho servicio, de lo contrario será rechazada dicha solicitud.
Observe en la siguiente imagen, que en lo que su solicitud se aprueba, permanece en estado “Solicitado” y por tanto las API KEY aún no sé asignan.
Seguidamente al ser aceptada la solicitud de suscripción al producto ya aparecen asignadas sus API KEYs (Principal y Secundaria).
3.- PRUEBAS EN EL PORTAL DEL DESARROLLADOR
El portal del desarrollador, brinda un espacio para realizar pruebas manuales, ver las características del cuerpo de la solicitud de la API y las diferentes respuestas. Para acceder a dicho espacio, basta con hacer clic sobre la opción “APIS” en el menú superior y luego sobre el API “BLACK LIST” del listado.
Al hacer clic sobre la ruta “BlackList_Post”, tendrá disponible un botón para entrar al contexto de pruebas, en las subsiguientes imágenes se muestran otras secciones que el desarrollador debe tener en cuenta. Como por ejemplo, el cuerpo de la solicitud (body request), aparecen además otros ejemplos “genéricos” de cómo consumir en lo generar un API REST desde varios lenguajes de programación.
Al hacer clic sobre el botón “Try it”, aparece una sección como la mostrada en la siguiente imagen. El atributo Ocp-Admin-Subscription-Key, es la llamada API KEY, principal o secundaria (de acuerdo a su elección), que se asignaron en el proceso de suscripción del punto 2 de este documento.
En este caso el cuerpo de la solicitud (body), es muy sencilla ya que se trata del RFC del contribuyente que queremos buscar dentro de las listas negras del SAT.
Oprima el botón “Enviar”
Respuesta:
Ejemplo de llamada desde JavaScript. Los valores representados en la imagen son ejemplos y no representan ningún valor real.