Vocabulario Api

Obtener más información sobre cómo se diseñan, desarrollan, implementan y administran las API.

 

AJAX
AJAX, que significa JavaScript y XML asincrónicos, es una técnica para crear páginas web dinámicas e interactivas. AJAX utiliza JavaScript para realizar solicitudes a un servidor web en segundo plano y recuperar datos en varios formatos, incluidos XML, HTML o JSON. Estos datos se pueden utilizar para actualizar partes específicas de una página web sin necesidad de actualizarla, lo que crea una experiencia más receptiva y fácil de usar.

 

Acceso API
El acceso a la API es la capacidad de interactuar con una API y permite a los clientes solicitar datos, crear o actualizar recursos y ejecutar operaciones específicas. El acceso a la API a menudo se otorga a través de mecanismos de autenticación de API, como la autenticación de clave de API, JWT y OAuth, lo que ayuda a proteger los datos confidenciales y garantiza que las capacidades de la API no se utilicen indebidamente.

 

Autenticación API
La autenticación de API es el proceso de verificar la identidad de un usuario que realiza una solicitud de API y es un pilar crucial de la seguridad de la API. Existen muchos tipos de autenticación API, como la autenticación básica HTTP, la autenticación de clave API, JWT y OAuth, y cada uno tiene sus propios beneficios, compensaciones y casos de uso ideales. Sin embargo, todos los mecanismos de autenticación de API comparten el objetivo de proteger los datos confidenciales y garantizar que no se haga un mal uso de la API.

 

Cliente API
Un cliente API es una herramienta de desarrollo que facilita a los productores y consumidores explorar, probar y depurar API. Los enfoques tradicionales para llamar a una API requieren una cantidad significativa de conocimientos especializados; por ejemplo, el usuario de la API debe conocer un lenguaje de programación, comprender el marco y el protocolo de la API y poder interpretar la respuesta. Este proceso que requiere mucho tiempo no solo ralentiza los esfuerzos de integración y desarrollo de API, sino que también impide que personas con conocimientos menos técnicos trabajen con API. Los clientes API abstraen parte de esta complejidad, lo que reduce la barrera de entrada para el trabajo relacionado con API y permite a los desarrolladores mantenerse enfocados en objetivos generales.

 

Colaboración API
La colaboración de API es el proceso mediante el cual desarrolladores, evaluadores, arquitectos y otras partes interesadas del negocio trabajan juntos para producir y consumir API. Es un pilar crucial del panorama de software actual, en el que los equipos aprovechan las API públicas, privadas y de socios para crear aplicaciones que sean resistentes, escalables y capaces de satisfacer las necesidades de los usuarios.

 

Credenciales API
Las credenciales API permiten a los clientes identificarse en un servidor API y son una parte crucial del flujo de trabajo de autenticación API. Cuando un cliente realiza una llamada API, incluye credenciales (como un par de nombre de usuario/contraseña, una clave API o un JWT) en la solicitud. Luego, el servidor API valida las credenciales y verifica si el cliente tiene los permisos necesarios para realizar la operación solicitada. Si las credenciales de API son válidas, el servidor API procesa la solicitud y devuelve la respuesta adecuada. Por lo tanto, las credenciales de API desempeñan un papel importante en la seguridad de la API al proteger la API y sus datos del acceso no autorizado.

 

Economía API
La economía API es el ecosistema económico que ha surgido en respuesta a la adopción generalizada de API. Está impulsado por la demanda de datos, servicios y funcionalidades que se entregan a través de las API, así como por el valor económico que crea este intercambio. La economía de las API abre oportunidades de monetización para los equipos que comercializan sus API como productos facturables, fomenta la colaboración a escala global y acelera la innovación y el avance tecnológico.

 

Ecosistema API
Un ecosistema API es la red de API, desarrolladores, plataformas y servicios dentro de una industria u organización en particular. Los ecosistemas de API públicos pueden incluir mercados de API y comunidades globales de desarrolladores, mientras que los ecosistemas de API privados pueden incluir catálogos de API privados y estándares y procesos internos para el trabajo relacionado con API. Los ecosistemas API están en constante evolución, lo que respalda la innovación y la colaboración.

 

Puerta de enlace API
Una puerta de enlace API es un servidor que actúa como punto de entrada para que los clientes accedan e interactúen con múltiples microservicios y sistemas backend. Las puertas de enlace API son un componente importante de las arquitecturas basadas en microservicios, ya que proporcionan un punto de control centralizado para muchas tareas comunes que de otro modo serían realizadas por cada microservicio individual. Por ejemplo, las puertas de enlace API normalmente manejan el enrutamiento de solicitudes, la traducción de protocolos, la seguridad, la limitación de velocidad, el almacenamiento en caché, el equilibrio de carga y el control de versiones de API. También pueden proporcionar varias funciones (como autenticación, autorización y análisis) para monitorear y administrar el uso de las API. Estas capacidades permiten a los desarrolladores crear un sistema más escalable, resistente y eficiente.

 

Encabezados API
Los encabezados de API contienen los metadatos que se envían junto con una solicitud o respuesta de API. Proporcionan detalles esenciales que ayudan al cliente y al servidor a comunicarse de manera más efectiva y permiten a los desarrolladores personalizar y optimizar el comportamiento de la API. Algunos ejemplos comunes de encabezados API incluyen:

Autorización: se utiliza para proporcionar información de autenticación, como un token o un nombre de usuario y contraseña.
Tipo de contenido: especifica el formato de los datos que se envían en la solicitud o respuesta, como JSON o XML.
Aceptar: especifica el formato de datos preferido que el cliente espera recibir en la respuesta.
Cache-Control: especifica directivas de almacenamiento en caché, como max-age y no-cache, para que la respuesta se almacene en caché o no.
Agente de usuario: especifica información sobre el cliente que realiza la solicitud, como el navegador o el dispositivo utilizado.

 

Clave API
Una clave API es un identificador único que se utiliza para autenticar y autorizar el acceso a una API. Se pasa una clave API junto con cada solicitud de API para identificar al cliente y garantizar que tenga los permisos necesarios para interactuar con el punto final relevante. Algunas claves de API otorgan acceso completo a la API, mientras que otras pueden proporcionar acceso de solo lectura, acceso de escritura o acceso a funciones o puntos finales específicos de la API. También se pueden configurar con límites de uso que restrinjan la cantidad de solicitudes por día, o con fechas de vencimiento para garantizar que el acceso sea revocado después de un cierto período de tiempo.

Los desarrolladores suelen utilizar las claves API para acceder a las API proporcionadas por servicios de terceros. Al requerir una clave API, el proveedor de API puede controlar el acceso a su API, monitorear el uso y restringir el acceso a usuarios autorizados.

 

Mercado de API
Los mercados de API son plataformas que facilitan el descubrimiento, la distribución y la monetización de API públicas. Permiten a los productores de API mostrar y comercializar sus API a una audiencia amplia mientras implementan modelos de precios o planes de suscripción basados en el uso. Los mercados de API pueden exigir que los productores de API sigan ciertos estándares o especificaciones, lo que proporciona una experiencia de incorporación sencilla y predecible para los consumidores de API.

 

Burla de API
La burla de API es el proceso de realizar solicitudes de API simuladas sin acceder a la API real. Implica crear una versión simulada de la API que replica sus respuestas, estructuras de datos y comportamiento. La simulación de API a menudo se realiza en las etapas de desarrollo y prueba del ciclo de vida de la API , ya que permite a los equipos confirmar que su API está funcionando como se esperaba antes de que la implementación completa sea estable. También facilita la colaboración entre los equipos de desarrollo frontend y backend al permitir que los desarrolladores frontend comiencen a trabajar en la interfaz de usuario antes de que se finalice la API.

 

Plataforma API
Una plataforma API es un sistema de software con herramientas y procesos integrados que permiten a los equipos crear, gestionar, publicar y consumir API de forma eficaz. Una plataforma API ayuda a los productores de API a gestionar todo el ciclo de vida de las API, desde el diseño hasta la producción, mientras interactúan directamente con los consumidores de API. Las plataformas API complementan y mejoran los flujos de trabajo existentes mediante integraciones con herramientas de administración de código fuente, canalizaciones de CI/CD, infraestructura en la nube y soluciones APM. También permiten a los líderes crear e implementar estrategias de seguridad y gobernanza de API que fomentan la colaboración, promueven la coherencia y reducen el riesgo.

 

Portal API
Los portales de API son centros centralizados para implementar API, crear catálogos de API y publicar documentación de API , y facilitan la integración de API al tiempo que agilizan el proceso de incorporación para los consumidores. Los portales API adquirieron prominencia en la primera década del siglo XXI y, si bien continúan desempeñando un papel importante en el ecosistema API, un número cada vez mayor de equipos están adoptando otras herramientas y métodos para crear comunidades y llegar a sus consumidores. Por ejemplo, la red API pública de Postman proporciona acceso a colecciones y espacios de trabajo públicos, lo que facilita a los consumidores explorar la funcionalidad de una API determinada.

 

Solicitud de API
Una solicitud API, también conocida como llamada API, es un mensaje que un cliente API envía a un servidor API para recuperar o manipular datos. Las solicitudes de API suelen incluir los siguientes componentes:

Punto final: un punto final es una URL dedicada que proporciona acceso a un recurso específico. Por ejemplo, el /productspunto final de una aplicación de comercio electrónico incluiría la lógica para procesar solicitudes relacionadas con productos.
Método: el método es la operación que al cliente le gustaría realizar en el recurso especificado. Se puede acceder a las API REST a través de métodos HTTP estándar, como GET , POST , PUT , PATCH y DELETE , que facilitan acciones comunes como recuperar, crear, actualizar o eliminar datos.
Parámetros: los parámetros son variables que se pasan a un punto final de API y proporcionan instrucciones específicas para que la API las procese. Por ejemplo, una solicitud a una aplicación de entrega de alimentos en línea podría aceptar un parámetro de «ubicación», que utilizaría para devolver restaurantes en una ubicación determinada.
Encabezados: los encabezados proporcionan información adicional sobre la solicitud. Por ejemplo, podrían usarse para especificar el formato de datos en el cuerpo de la solicitud o para pasar credenciales de autenticación.
Cuerpo: el cuerpo de la solicitud es opcional y solo se incluye cuando el cliente necesita crear, actualizar o eliminar un recurso. Si está presente, incluye los datos que el cliente quiere crear o manipular.

 

Pruebas API
La prueba de API es el proceso de validar que una API funciona como se esperaba. Las pruebas de API se pueden realizar manualmente de forma ad hoc o se pueden automatizar con una herramienta de prueba que ejecuta scripts de prueba en intervalos predeterminados o en respuesta a eventos. Tradicionalmente, las pruebas de API se realizaban al final de la fase de desarrollo, justo antes de que los cambios se implementaran en producción, pero un número cada vez mayor de equipos ejecuta pruebas en una etapa más temprana del ciclo de vida de la API. Este enfoque para las pruebas de API, que se conoce como «desplazamiento hacia la izquierda», admite una iteración rápida al permitir que los equipos detecten y solucionen problemas tan pronto como se presenten.

 

API first
API-first es un modelo de desarrollo en el que las aplicaciones se conceptualizan y construyen como una colección de servicios internos y externos que se entregan a través de API. Esta estrategia trata las API como componentes cruciales de la infraestructura y permite a los equipos aprovechar las API públicas, privadas y de socios para cerrar las brechas entre fragmentos de código pequeños y discretos para crear aplicaciones que sean potentes, resistentes y capaces de satisfacer las necesidades de los usuarios.

 

Cache
Un caché es un componente de infraestructura que almacena temporalmente datos a los que se accede con frecuencia para que puedan entregarse de manera más rápida y eficiente. Cuando un cliente API realiza una solicitud, el servidor puede verificar el caché para ver si los datos solicitados ya están disponibles. Si es así, el servidor puede devolver la respuesta almacenada en caché directamente al cliente, sin tener que ejecutar la solicitud completa nuevamente. Este enfoque mejora significativamente el rendimiento de la API al reducir la cantidad de solicitudes que el servidor necesita procesar, lo que minimiza la latencia y mejora la escalabilidad.

 

CORS
CORS, que significa intercambio de recursos entre orígenes, es una característica de seguridad basada en encabezados HTTP que permite a las páginas web realizar solicitudes a un origen diferente (es decir, un dominio, protocolo o puerto) del que se originó la página.

 

CRUD
CRUD, que significa Crear, Leer, Actualizar y Eliminar, se refiere a un conjunto de operaciones básicas que se pueden realizar con datos en una base de datos u otro sistema de almacenamiento de datos. Las operaciones CRUD se realizan con mayor frecuencia con cinco métodos HTTP estándar: GET , POST , PUT , PATCH y DELETE . CRUD es un concepto fundamental en el desarrollo de software y se utiliza para gestionar datos en una amplia gama de aplicaciones, como sistemas de gestión de contenidos, sitios web de comercio electrónico, plataformas de redes sociales y más.

rizo
cURL es una herramienta de línea de comandos que facilita la transferencia de datos hacia o desde un servidor utilizando varios protocolos, como HTTP , HTTPS, FTP, FTPS, SCP y SFTP. cURL está disponible en la mayoría de los sistemas operativos, incluidos Linux, macOS y Windows, y se puede usar en una terminal o desde un script. cURL se usa ampliamente para probar API, depurar problemas de red y automatizar tareas repetitivas. También se utiliza para agregar encabezados y cookies a solicitudes, seguir redirecciones, especificar credenciales de autenticación y verificar certificados SSL/TLS.

 

BORRAR
DELETE es un método HTTP estándar que se utiliza para eliminar datos en un servidor. Cuando un cliente envía una solicitud DELETE, solicita que se elimine el recurso en la URL especificada. Si el servidor acepta la solicitud, eliminará el recurso y devolverá una respuesta que indica el éxito. Por ejemplo, una solicitud de eliminación al /users/123punto final debería dar como resultado la eliminación del recurso del usuario con una IDextensión de 123.

 

Punto final
Un punto final de API es una URL que se utiliza para recuperar, crear, actualizar o eliminar datos en un servidor. Una API bien diseñada debe tener puntos finales claros e intuitivos que proporcionen una forma consistente y predecible para que los clientes interactúen con los recursos del servidor.

 

Get
GET es un método HTTP estándar que se utiliza para recuperar datos en un servidor. Cuando un cliente envía una solicitud GET, utiliza una URL específica para identificar el recurso que desea. Si el servidor acepta la solicitud, devolverá una respuesta que incluye la representación del recurso en HTML, JSON, XML u otro formato.

 

gRPC
gRPC es un marco de llamada a procedimiento remoto (RPC) de código abierto y alto rendimiento que puede ejecutarse en muchos entornos. gRPC permite que las aplicaciones cliente y servidor se comuniquen de forma transparente y simplifica el proceso de creación de sistemas conectados. gRPC utiliza Protocol Buffers como formato de intercambio de datos subyacente y HTTP/2 como protocolo de transporte.

 

GraphQL
GraphQL es un lenguaje de consulta para API y un tiempo de ejecución del lado del servidor para ejecutar consultas utilizando un sistema de tipos que usted define para sus datos. Con GraphQL, los clientes interactúan con un único punto final y especifican los datos exactos que necesitan, sin tener que encadenar varias solicitudes. Este enfoque reduce la cantidad de viajes de ida y vuelta entre el cliente y el servidor, lo que puede mejorar el rendimiento, especialmente en conexiones de red lentas o poco confiables. Además, GraphQL no devuelve datos que el cliente no solicitó, lo que mejora la eficiencia al reducir la cantidad de datos que se transfieren.

 

HTTP
HTTP, que significa Protocolo de transferencia de hipertexto, es un protocolo estandarizado para transmitir datos (como páginas HTML, imágenes y vídeos) entre clientes y servidores en Internet. HTTP funciona en el modelo cliente-servidor, donde el cliente envía una solicitud HTTP al servidor y espera una respuesta. HTTP utiliza un conjunto estándar de métodos de solicitud, como GET, POST, PUT y DELETE, para especificar el tipo de acción que el cliente desea realizar en un recurso determinado.

 

JSON
JSON, significa notación de objetos JavaScript, es un formato de datos liviano basado en texto que es fácil de leer y escribir para humanos y máquinas. JSON se basa en la sintaxis del lenguaje de programación JavaScript y utiliza pares clave-valor para representar objetos de datos. Las claves JSON son cadenas y sus valores pueden ser cadenas, números, valores booleanos, matrices u otro objeto JSON. Los pares clave-valor están separados por comas y los objetos están entre llaves.
JSON se ha convertido en un formato popular para transmitir datos a través de Internet debido a su simplicidad, compacidad y legibilidad. Es compatible con muchos lenguajes y plataformas de programación y, a menudo, se utiliza en API RESTful para transmitir datos entre servidores y clientes.

 

Esquema JSON
JSON Schema es un lenguaje declarativo que le permite anotar y validar documentos JSON. JSON Schema es un estándar industrial abierto que permite el uso seguro y confiable del formato de datos JSON. El esquema JSON se utiliza a menudo para fines que van más allá de aquellos para los que fue diseñado, como la generación de código, la generación de UI o formularios y la generación de datos de prueba.

 

Microservicios
Un microservicio es un pequeño servicio que realiza una única función empresarial y se comunica con otros microservicios a través de API. Cada microservicio se gestiona de forma independiente entre sí, lo que puede acelerar el proceso de desarrollo e implementación y facilitar la escala y el mantenimiento del sistema.

 

Monolito
Un monolito es una aplicación que se desarrolla e implementa como una sola unidad. Sus componentes están estrechamente acoplados dentro de una única base de código y, a menudo, comparten recursos, como bases de datos o bibliotecas.

 

OAuth
OAuth es un protocolo de autorización estándar abierto que permite que aplicaciones de terceros obtengan acceso limitado a cuentas de usuario en un servicio HTTP, sin comprometer la contraseña del usuario. OAuth 2.0, que proporciona mayor flexibilidad y escalabilidad que OAuth 1.0, se ha convertido en una opción líder para la autenticación en aplicaciones web, móviles y de escritorio.

 

API abierta
OpenAPI (anteriormente conocido como Swagger) es el formato de especificación más utilizado para describir y documentar los puntos finales, métodos, parámetros, respuestas y más de una API. La especificación OpenAPI proporciona un rico ecosistema de herramientas para trabajar con API y se puede utilizar para generar bibliotecas de cliente, documentación y otros artefactos.

 

Conexión OpenID
OpenID Connect (OIDC) es una capa de identidad además de OAuth 2.0 que define cómo las aplicaciones cliente pueden obtener información sobre un usuario de un proveedor de identidad. OIDC permite a los usuarios autenticarse con un flujo de inicio de sesión único (SSO) y luego compartir su información de identidad con otras aplicaciones sin tener que volver a ingresar sus credenciales.

 

Parámetros
Los parámetros son las variables que se pasan a un punto final de API para proporcionar información o instrucciones específicas para que la API las procese. Estos parámetros se pueden incluir en la solicitud de API como parte de la URL, en la cadena de consulta o en el cuerpo de la solicitud.

 

Patch
PATCH es un método HTTP que se utiliza para actualizar o modificar un recurso existente. Es similar al método PUT, excepto que PUT reemplaza todo el recurso, mientras que PATCH solo aplica una actualización parcial al recurso. Por ejemplo, si tiene un recurso de usuario con campos para nombre, correo electrónico y contraseña, pero solo desea actualizar el valor del correo electrónico, puede usar el método PATCH para enviar una solicitud que solo incluya el nuevo valor para el campo de correo electrónico. Por tanto, el método PATCH es una poderosa herramienta para actualizar recursos de manera flexible y eficiente.

 

Post
POST es un método HTTP que normalmente se utiliza para crear nuevos recursos. Por ejemplo, una solicitud POST a un punto final /user creará un nuevo registro de usuario en la base de datos que se basa en los datos incluidos en el cuerpo de la solicitud. El método POST a menudo provoca un cambio de estado o efectos secundarios en el servidor.

 

Put
PUT es un método de solicitud HTTP que se utiliza para reemplazar un recurso existente con una versión actualizada. A diferencia del método PATCH, en el que solo se actualizan los campos o propiedades incluidos en el cuerpo de la solicitud, PUT reemplaza todo el recurso con los datos que se envían en el cuerpo de la solicitud. Esto significa que todos los campos o propiedades no incluidos en la nueva representación se eliminan y se agregan todos los campos o propiedades nuevos. Este comportamiento puede hacer que las solicitudes PUT sean bastante grandes, especialmente para recursos complejos con muchos campos o propiedades.

 

RAML
RAML, que significa RESTful API Modeling Language, es un lenguaje de especificación que se utiliza para definir las API RESTful. Proporciona una manera de documentar los recursos, métodos, parámetros y respuestas de una API en un formato estructurado y legible por máquina. RAML admite una amplia gama de funciones, incluido el enrutamiento de URL, modelos de solicitud/respuesta, tipos de medios, seguridad y más.

 

Rest
REST (Transferencia de estado representacional) es un estilo arquitectónico para crear servicios web y API. En una arquitectura RESTful, los recursos se identifican mediante URI (identificadores uniformes de recursos) y las operaciones se realizan en esos recursos utilizando métodos HTTP estándar como GET, POST, PUT y DELETE. El estado de un recurso se representa en JSON o XML, que se transfiere entre el cliente y el servidor en los cuerpos de solicitud y respuesta HTTP.

 

RPC
RPC, que significa Llamada a procedimiento remoto, es una técnica para construir sistemas distribuidos que permite a los programas llamar a funciones en otras máquinas como si fueran locales. En un sistema RPC, un programa cliente envía una solicitud a un programa servidor remoto para realizar un procedimiento específico, pasando todos los datos de entrada necesarios. Luego, el servidor procesa la solicitud y devuelve una respuesta con los datos de salida. Luego, el programa cliente puede continuar su ejecución en función de la respuesta que recibe.

 

Prueba de desplazamiento a la izquierda
Las pruebas de desplazamiento a la izquierda son la práctica de ejecutar pruebas en cada etapa del ciclo de desarrollo.

 

Soap
SOAP (Protocolo simple de acceso a objetos) es un protocolo de mensajería para intercambiar datos estructurados a través de Internet. Está basado en XML y se utiliza para facilitar la comunicación entre diferentes aplicaciones y sistemas, especialmente en un entorno distribuido.

 

Códigos de estado
Los códigos de estado de API son códigos de estado HTTP que devuelve una API para indicar el estado de la solicitud de un cliente. Estos códigos se utilizan para proporcionar información al cliente sobre el resultado de la solicitud y para ayudarlo a comprender cómo proceder.Como 200 , 201 , 401 …

 

Webhooks
Los webhooks permiten que las aplicaciones proporcionen notificaciones en tiempo real a otros sistemas enviando una solicitud HTTP a una URL específica cuando ocurre un evento en particular. Los webhooks son una forma eficiente y escalable de implementar arquitecturas basadas en eventos porque eliminan la necesidad de sondear continuamente una API en busca de cambios.

 

XML
XML (lenguaje de marcado extensible) es un lenguaje de marcado que se utiliza para codificar documentos en un formato que pueden leer tanto humanos como máquinas. Los documentos XML se componen de etiquetas de marcado que definen la estructura y el contenido del documento. Cada etiqueta define un elemento, que puede contener texto, otros elementos o atributos que describen sus propiedades. Un documento XML debe tener un elemento raíz que incluya todos los demás elementos del documento.

FUENTE : https://www.postman.com/api-glossary/