Flujo para un correcto funcionamiento de la API de Extractores
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"25579567","collectionId":"ebc3e3f9-8a9d-4550-967a-7bfbc7fd5fb1","publishedId":"2sA35EZNc7","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"258ceb"},"publishDate":"2024-03-27T20:04:59.000Z"},"item":[{"name":"Authentication","item":[{"name":"getKeyKeycloakEmailPassword","id":"9be857c4-5f93-4593-8dff-76956cd3bda3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"client_id","value":"data-wallet","type":"text"},{"key":"client_secret","value":"","type":"text"},{"key":"grant_type","value":"password","type":"text"},{"key":"username","value":"","type":"text"},{"key":"password","value":"","type":"text"}]},"url":"http://localhost:8080/realms/data-wallet/protocol/openid-connect/token","description":"Este endpoint es usado para poder obtener el token de sesión para poder ser utilizado en el header de Authorization para permitir el uso de los servicios de esta documentación.
\n","urlObject":{"protocol":"http","port":"8080","path":["realms","data-wallet","protocol","openid-connect","token"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"9be857c4-5f93-4593-8dff-76956cd3bda3"},{"name":"GenerateApiToken","id":"b5d4fa56-c742-454c-a377-129f8a8f97ea","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"authorization","value":"","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"mutation GenerateApiToken {\n GenerateApiToken {\n token\n }\n}\n","variables":""}},"url":"","description":"Para la obtención del apiToken, tendremos que hacer una solicitud a GenerateApiToken, esto nos generara un token que usaremos para todos los extractores, este Token es generado para el uso de un solo wallet_id asociado a un usuario, esto se determina gracias al access_token.
\nSalida esperada:
\n{\n \"data\": {\n \"GenerateApiToken\": {\n \"token\": \"DtN0KMzkbk3dpkOaou7SiJEheT0hL9I30xRJMr9DFfTypFsyRV\"\n }\n }\n}\n\nExtracción INE, este extractor requiere de 2 entradas de tipo documento, la forma que se recomienda enviar el documento a la api utilizando postman es la que se muestra como ejemplo.
\nLa entrada front, sera una imagen que contenga una INE de su lado frontal, la entrada back, sera una imagen que contenga una INE de su lado trasero.
\nEs importante enviar ambas.
\n","urlObject":{"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"d92807cd-69f4-4655-bb26-dba5bdd65133"},{"name":"Curp","id":"28b0e83d-f1ca-490b-b318-de326d6b59dd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"mutation ExtractCurp {\n extract(\n input: {CurpService: {curp:\"\"}}\n ) {\n requestId\n transactionId\n serviceId\n status {\n message\n } \n ... on CurpService{\n transactionId\n serviceId\n __typename\n status {\n code\n message\n }\n data {\n curp\n nombres\n }\n }\n }\n}","variables":""}},"url":"","description":"Extracción CURP requiere unicamente de una entrada llamada CurpService, esta entrada tendra un parametro llamado curp.
\nmutation ExtractCurp {\n extract(\n input: {CurpService: {curp:\"\"}}\n ) {\n requestId\n transactionId\n serviceId\n status {\n message\n } \n ... on CurpService{\n transactionId\n serviceId\n __typename\n status {\n code\n message\n }\n data {\n curp\n nombres\n }\n }\n }\n}\n\nExtracción Blacklists, este endpoint requiere de 2 entradas, el rfc que se quiere consultar y las listas que se quieren consultar, teniendo 2 opciones: [Blacklist_69,Blacklist_69B]
\nmutation ExtractBlackLists {\n extract(\n input: {\n BlacklistService: {\n queries:{\n schema:PERSON, \n properties:{\n name:\"\", \n jurisdiction:[\"mx\"],\n taxNumber:\"\"\n }\n }\n }\n }\n ) {\n transactionId\n requestId\n serviceId\n status {\n message\n } \n ... on BlacklistService {\n transactionId\n serviceId\n __typename\n status {\n code\n message\n }\n data {\n \n lists {\n type\n encontrado\n score\n }\n }\n }\n }\n}\n\nConsulta de información a través del portal REPSE https://repse.stps.gob.mx/
Registro de Prestadoras de Servicios Especializados u Obras Especializadas
Parametros:
\nt: int
SEARCH = Búsqueda por Razón Social o Nombre de Empresa.
SEARCH_ALL = Búsqueda sobre todos los campos que tiene la base del REPSE, incluyendo los servicios que ofrece.
2 = Listado de empresas en las cuales su fecha de vigencia de registro vence en el año actual.
query: str
\nmutation ExtractRepse {\n extract(input: {RepseService: {name: \"\", typeSearchRepse:SEARCH_CURRENT_YEAR}}) {\n transactionId\n serviceId\n status {\n message\n }\n ... on RepseService {\n transactionId\n serviceId\n __typename\n status {\n code\n message\n }\n data {\n name\n }\n }\n }\n}\n\nExtracción Liveness, este extractor se requiere enviar el parametro intro en true, esto para ser llamado, una vez llamado, se espera que devuelva un link donde el usuario pueda comenzar el flujo de Liveness.
\nmutation ExtractLiveness{\n extract(\n input: {LivenessService: {intro: true}}\n ) {\n transactionId\n serviceId\n status {\n message\n } \n ... on LivenessService{\n transactionId\n serviceId\n __typename\n status {\n code\n message\n }\n data {\n link\n }\n }\n }\n}\n\nExtracción Validación laboral requiere unicamente de una entrada llamada ValidacionLaboralService, esta entrada tendra un parametro llamado curp.
\nmutation ExtractLaboral {\n extract(\n input: {ValidacionLaboralService: {curp:\"\"}}\n ) {\n requestId\n transactionId\n serviceId\n status {\n message\n } \n ... on ValidacionLaboralService{\n transactionId\n serviceId\n __typename\n status {\n code\n message\n }\n data {\n curp\n }\n }\n }\n}\n\nExtracción de opinión de cumplimiento.
\nEste extractor necesita recibir 2 archivos que se cargan en los valores de 0 y 1, siendo el cer el valor de 0 y la key el valor de 1.
\n","urlObject":{"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"a488be01-1ed1-4846-9a88-cda91a08c4a0"},{"name":"Constancia","id":"026266be-33ae-49de-959d-ae36b71a38cc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"operations","value":"{\n \"query\": \"mutation ExtractConstancia($input: ExtractInput!) { extract(input: $input) { transactionId serviceId status { message } ... on ConstanciaService { transactionId requestId serviceId __typename status { code message } } } }\",\n \"variables\": {\n \"input\": {\n \"ConstanciaService\": {\n \"cer\": null,\n \"key\": null,\n \"password\": \"\",\n \"rfc\": \"\"\n }\n }\n }\n}\n","type":"text"},{"key":"map","value":"{\n \"0\": [\"variables.input.ConstanciaService.cer\"],\n \"1\": [\"variables.input.ConstanciaService.key\"]\n}\n","type":"text"},{"key":"0","type":"file","value":null},{"key":"1","type":"file","fileNotInWorkingDirectoryWarning":"This file isn't in your working directory. Teammates you share this request with won't be able to use this file. To make collaboration easier you can setup your working directory in Settings.","filesNotInWorkingDirectory":["/home/antonio/urdaten/Archivos/test/test_opinion_cumplimiento/Claveprivada_FIEL_ACA100423K25_20221214_083833.key"],"value":null}]},"url":"","description":"Extracción de constancia.
\nEste extractor necesita recibir 2 archivos que se cargan en los valores de 0 y 1, siendo el cer el valor de 0 y la key el valor de 1.
\n","urlObject":{"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"026266be-33ae-49de-959d-ae36b71a38cc"},{"name":"Domicilio","id":"08b6b554-b6d9-4c1a-aa96-fb0b96b1f06e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"operations","value":"{\n \"query\": \"mutation ExtractDomicilio($input: ExtractInput!) { extract(input: $input) { transactionId requestId serviceId status { message } ... on XDomicilioService { transactionId serviceId __typename status { code message } } } }\",\n \"variables\": {\n \"input\": {\n \"XDomicilio\": {\n \"document\": null,\n \"validate\": false,\n \"months\": 6\n }\n }\n }\n}\n","type":"text"},{"key":"map","value":"{\n \"0\": [\"variables.input.XDomicilio.document\"]\n}\n","type":"text"},{"key":"0","type":"file","fileUploadError":"","fileNotInWorkingDirectoryWarning":"This file isn't in your working directory. Teammates you share this request with won't be able to use this file. To make collaboration easier you can setup your working directory in Settings.","filesNotInWorkingDirectory":["/home/antonio/Downloads/364497665-af904ed5-e4d6-4e78-9235-bae6ee20a227.jpg"],"value":null}]},"url":"http://localhost:8081/api/query","description":"Extracción de comprobante de domicilio, este extractor requiere de un documento como un recibo de luz, la forma que se recomienda enviar el documento a la api utilizando postman es la que se muestra como ejemplo.
El documento se carga en la key llamada 0.
Extracción Financiero, este extractor requiere de un documento donde se encuentre un estado financiero, la forma que se recomienda enviar el documento a la api utilizando postman es la que se muestra como ejemplo.
\n","urlObject":{"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"a58fadfa-babf-4ca3-a7f4-66e6510ebf67"},{"name":"Bancario","id":"142acdf2-7d75-460d-b3cc-289a0237add5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"operations","value":"{\n \"query\": \"mutation ExtractBancario($input: ExtractInput!) { extract(input: $input) { transactionId requestId serviceId status { message } ... on XBankStatementService { transactionId serviceId __typename status { code message } data { name } } } }\",\n \"variables\": {\n \"input\": {\n \"XBankStatementService\": {\n \"document\": null\n }\n }\n }\n}\n","type":"text"},{"key":"map","value":"{\n \"0\": [\"variables.input.XBankStatementService.document\"]\n}\n","type":"text"},{"key":"0","type":"file","fileNotInWorkingDirectoryWarning":"This file isn't in your working directory. Teammates you share this request with won't be able to use this file. To make collaboration easier you can setup your working directory in Settings.","filesNotInWorkingDirectory":["/home/antonio/Downloads/Hugo Espinosa Callejas (1).pdf"],"value":null}]},"url":"","description":"Extracción Bancario, este extractor requiere de un documento donde se encuentre un estado bancario, la forma que se recomienda enviar el documento a la api utilizando postman es la que se muestra como ejemplo.
\n","urlObject":{"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"142acdf2-7d75-460d-b3cc-289a0237add5"},{"name":"Document Understanding","id":"fa3ba976-970d-4413-b507-b28eeadacb28","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"operations","value":"{\n \"query\": \"mutation xtract($file: Upload!) { verify(input: { ClassifierService: { document: $file, analyses: AnalysesClassifier } }) { requestId transactionId serviceId } }\",\n \"variables\": { \"file\": null }\n}","type":"text","uuid":"5f96d43f-4119-40c8-bd84-f4c3c58c3ede"},{"key":"map","value":"{ \"0\": [\"variables.file\"] }","type":"text","uuid":"df9dee04-7a11-4f58-8075-c6063f326ade"},{"key":"0","type":"file","uuid":"7bbaccc4-1814-4ee5-a00f-fb103c131fe0","value":null}]},"url":"","description":"Document Understanding es un servicio de IA que permite ontener información importante de tus documentos, por el momento sólo procesamos actas contitutivas en formato pdf. La forma que se recomienda enviar el documento via api utilizando POSTMAN es como se muestra en el ejemplo:
\nDocument Understanding permite realizar análisis de seguridad y cumplimiento. El parámetro AnalysesClassifier define qué validaciones se ejecutarán en la petición:
\nNONE: Solo se obtiene información importante sin ningún análisis adicional.
BLACKLIST: Validación en listas negras, restrictivas locales y globales.
LEGAL_RELEVANCE: Análisis de relevancia legal como por ejemplo, Cláusulas especiales, Riesgos Legales, etc.
BOTH: Ejecuta tanto el análisis de blacklist como el de relevancia legal.
Autofiller es un servicio que está ligado con Document Understanding, en donde se puede enviar un formulario en formato PDF (AcroForms) y el servicio de Autofiller llenará la información que encuentre como resultado del Document Understanding.
\nLa forma que se recomienda enviar el formulario via api, utilizando postman es como se muestra en el ejemplo:
\n","urlObject":{"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"c2fe739b-e886-4088-90cc-c45b208add69"}],"id":"3b2dc153-5d61-406f-aea5-0df27759ba92","_postman_id":"3b2dc153-5d61-406f-aea5-0df27759ba92","description":""},{"name":"WdsVerifyStatusXtractors","id":"c8a5728c-6190-4327-a379-5ab05913e582","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"authorization","value":"","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query FetchResultsFrom {\n FetchResultsFrom(\n input: {\n transactionId: \"\"\n requestId: \"\"\n apiToken: \"\"\n }\n ) {\n status\n data {\n Id\n RequestId\n Name\n Value\n CategoryId\n SectionId\n Required\n FieldType\n Validation\n WalletId\n StaticId\n Metadata\n Verified\n }\n }\n}\n","variables":""}},"url":"","description":"Una vez terminados los extractores, podras verificar su status.
\n","urlObject":{"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"c8a5728c-6190-4327-a379-5ab05913e582"}],"variable":[{"key":"PROD-URL","value":"","type":"default"}]}