Manual de Referencia: Manejo de API's en CONTPAQi®
×
Menú

Glosario

 
En la siguiente tabla podrás verificar que significan los términos que se utilizan en este documento:
 
Término
Descripción
Endpoint
Es un dispositivo informático remoto que se comunica con una red a la que está conectado.
API
Interfaz de Programación de Aplicaciones. Es un conjunto de definiciones y protocolos que se utiliza para desarrollar e integrar el software de las aplicaciones.
POST
Son diferentes puntos finales de comunicación o endpoints cuando envías un sólo CFDI en XML, o cuando envías un archivo ZIP con varios CDFI en formato XML.
 
Permite actualizar un recurso o un conjunto de recursos. Si los datos no existen, el servicio de integración de datos crea el recurso o el conjunto de recursos.
PUT
Una solicitud de actualización debe proporcionar el ID exclusivo del recurso. Para actualizar un recurso de estructura de objeto, se requiere el ID del objeto principal. Reemplaza todas las representaciones actuales del recurso de destino con la carga útil de la petición; por lo que permite actualizar los datos a través de un servicio web REST.
GET
Define un método de descriptor de acceso en una propiedad o un indizador que devuelve el valor de acuerdo a la propiedad o la instrucción.
 
Generan una instrucción que devuelve un valor
Los parámetros se mantienen dentro del servidor, ya que forman una parte de la URL (Localizador uniforme de recursos).
XML
Lenguaje de Marcas Extensible. Define un conjunto de reglas para la codificación de documentos, que sirve para almacenar datos y facilitar su transmisión entre diferentes tecnologías sin afectar su estructura original.
ZIP
Formato que permite comprimir uno o más archivos juntos, reduciendo el tamaño y facilitando la transportación del mismo.
AWS - S3
Amazon Web Services - Almacenamiento en la nube seguro.
S3 permite almacenar y proteger cualquier volumen de datos para los más variados fines, como usarlos en lagos de datos, sitios web, aplicaciones móviles, procesos de copia de seguridad y restauración, operaciones de archivado, entre otros.
TFD
Desarrollo de Pruebas. Es la practica de diseñar pruebas de un programa, antes de implementarlo.
Python 3.7
Es un lenguaje de programación potente y fácil de aprender. Tiene estructuras de datos de alto nivel eficientes y un simple pero efectivo sistema de programación orientado a objetos. Su filosofía hace hincapié en la legibilidad de su código.
Timbrado masivo para ISVs v1
Recibe un comprobante sellado en formato string o en su defecto en bytes, posteriormente retorna el complemento Timbre Fiscal Digital (TFD) correspondiente al XML que se envió a timbrar ó en su defecto retorna una excepción detallando el error de validación.
bytes
Conjunto de 8 bits que recibe el tratamiento de una unidad y que constituye el mínimo elemento de memoria direccionable de una computadora.
JSON
Notación de Objeto Javascript, que sirve para representar estructuras de sintaxis de programación.
Metadata
Datos que describen otros datos o "datos sobre datos".
Encriptar
Proceso de seguridad que se utiliza para el manejo de datos sensibles o confidenciales, los cuales se ocultan mediante algoritmos, con la finalidad de que solo sean interpretados por quien tiene la clave.