Cómo usar la API de Akamai: Una guía para desarrolladores

La entrega de contenido y la seguridad son primordiales para las empresas que operan en línea. Akamai, un líder mundial en servicios de red de entrega de contenido (CDN), ofrece una potente API que permite a los desarrolladores aprovechar todo el potencial de su plataforma de forma programática. Esta guía completa explorará la API de Akamai, sus características, implementación y mejores prácticas, ayudándole a optimizar sus aplicaciones web para la velocidad, la seguridad y la escalabilidad.

Entendiendo la API de Akamai

La API de Akamai proporciona a los desarrolladores acceso programático a la amplia gama de servicios y características de Akamai. Al aprovechar esta API, puede automatizar tareas, integrar las capacidades de Akamai en sus flujos de trabajo existentes y crear soluciones personalizadas adaptadas a sus necesidades específicas.

Características clave de la API de Akamai

Purgado de contenido: Elimine o actualice instantáneamente el contenido almacenado en caché en toda la red global de Akamai.
Gestión de la configuración: Gestione e implemente mediante programación las configuraciones de sus servicios de Akamai.
Análisis en tiempo real: Acceda a análisis detallados de rendimiento y seguridad para sus propiedades web.
Controles de seguridad: Implemente y gestione funciones de seguridad como las reglas del firewall de aplicaciones web (WAF).
Edge Compute: Implemente y gestione funciones sin servidor en el borde para mejorar el rendimiento.

Empezando con la API de Akamai

Para empezar a utilizar la API de Akamai, deberá seguir estos pasos iniciales:

1. Cree una cuenta de Akamai

Si aún no lo ha hecho, regístrese para obtener una cuenta de Akamai. Esto le dará acceso al Centro de control de Akamai, donde podrá gestionar sus servicios y generar credenciales de API.

2. Genere credenciales de API

Una vez que haya iniciado sesión en el Centro de control de Akamai:

Vaya a la sección "Identidad y acceso".
Haga clic en "Usuarios de API" y luego en "Crear usuario de API".
Siga las indicaciones para generar sus credenciales de cliente de API, incluido el token de cliente, el secreto de cliente y el token de acceso.

3. Elija su cliente de API

Akamai proporciona clientes de API oficiales para varios lenguajes de programación, incluyendo:

Python
Node.js
Java
Go

Alternativamente, puede utilizar clientes HTTP de terceros o crear su propia implementación siguiendo las especificaciones de autenticación de Akamai.

Entendiendo la autenticación de la API de Akamai

Akamai utiliza un método de autenticación único llamado EdgeGrid para sus solicitudes de API. Este método implica firmar sus solicitudes con sus credenciales de API para garantizar una comunicación segura. Si bien el proceso puede ser complejo, el uso de clientes de API de Akamai oficiales simplifica esto significativamente.

Ejemplo: Autenticación con Python

Aquí hay un ejemplo básico de cómo autenticarse y realizar una solicitud utilizando el cliente de Python de Akamai:

from akamai.edgegrid import EdgeGridAuth, EdgeRc
from urllib.parse import urljoin
import requests

# Load credentials from .edgerc file
edgerc = EdgeRc('~/.edgerc')
section = 'default'

# Create a session with EdgeGrid authentication
session = requests.Session()
session.auth = EdgeGridAuth.from_edgerc(edgerc, section)

# Make an API request
baseurl = 'https://%s' % edgerc.get(section, 'host')
result = session.get(urljoin(baseurl, '/diagnostic-tools/v2/ghost-locations/available'))

print(result.json())

Este script carga sus credenciales de API desde un archivo .edgerc, crea una sesión autenticada y realiza una solicitud simple para recuperar las ubicaciones fantasma disponibles.

Casos de uso comunes de la API de Akamai

Exploremos algunos casos de uso comunes para la API de Akamai y cómo implementarlos:

1. Purgado de contenido

El purgado de contenido es una de las características de la API más utilizadas. Le permite eliminar o actualizar el contenido almacenado en caché en la red de Akamai al instante.

# Assuming you've set up authentication as in the previous example
endpoint = '/ccu/v3/invalidate/url'
payload = {
    "objects": [
        "<https://www.example.com/image.jpg>",
        "<https://www.example.com/script.js>"
    ]
}

result = session.post(urljoin(baseurl, endpoint), json=payload)
print(result.json())

Este script envía una solicitud para purgar URL específicas de la caché de Akamai.

2. Recuperación de información de la propiedad

Puede utilizar la API de Akamai para recuperar información sobre sus propiedades, incluidas sus configuraciones y estado.

endpoint = '/papi/v1/properties'
result = session.get(urljoin(baseurl, endpoint))
properties = result.json()

for property in properties['properties']['items']:
    print(f"Property Name: {property['propertyName']}")
    print(f"Property ID: {property['propertyId']}")
    print("---")

Este script recupera y muestra información básica sobre todas las propiedades de su cuenta.

3. Gestión de configuraciones de seguridad

La API de Akamai le permite gestionar las configuraciones de seguridad, incluidas las reglas WAF:

endpoint = f'/appsec/v1/configs/{config_id}/versions/{version}/security-policies/{policy_id}/attack-groups'
result = session.get(urljoin(baseurl, endpoint))
attack_groups = result.json()

for group in attack_groups['attackGroups']:
    print(f"Attack Group: {group['groupName']}")
    print(f"Enabled: {group['enabled']}")
    print("---")

Este script recupera y muestra información sobre los grupos de ataque configurados en una política de seguridad específica.

Mejores prácticas para usar la API de Akamai

Para aprovechar al máximo la API de Akamai y garantizar una integración fluida con sus sistemas, considere las siguientes mejores prácticas:

Utilice clientes oficiales: Siempre que sea posible, utilice los clientes de API oficiales de Akamai. Manejan la autenticación y la firma de solicitudes, lo que reduce la probabilidad de errores.
Implemente la limitación de velocidad: Akamai impone límites de velocidad en las solicitudes de API. Implemente la limitación de velocidad adecuada en sus aplicaciones para evitar alcanzar estos límites.
Maneje los errores con elegancia: Incluya siempre el manejo de errores en sus interacciones con la API. Akamai proporciona respuestas de error detalladas que pueden ayudarle a solucionar problemas.
Proteja sus credenciales: Almacene sus credenciales de API de forma segura. Nunca las codifique en sus aplicaciones ni las exponga en repositorios públicos.
Supervise el uso de la API: Realice un seguimiento del uso de su API para optimizar el rendimiento y evitar costes inesperados.
Manténgase actualizado: Akamai actualiza regularmente su API. Manténgase informado sobre los cambios y las nuevas características siguiendo su documentación para desarrolladores y las notas de la versión.
Utilice Webhooks: Para las notificaciones en tiempo real, considere la posibilidad de implementar la funcionalidad de webhook de Akamai en lugar de sondear la API repetidamente.

Características avanzadas de la API de Akamai

A medida que se sienta más cómodo con los conceptos básicos, explore estas características avanzadas de la API de Akamai:

1. Edge Compute

Los EdgeWorkers de Akamai le permiten ejecutar JavaScript personalizado en el borde, más cerca de sus usuarios. Puede utilizar la API para gestionar e implementar estas funciones:

endpoint = f'/edgeworkers/v1/ids/{ew_id}/versions/{version}/activate'
payload = {
    "network": "STAGING",
    "note": "Activating new version"
}

result = session.post(urljoin(baseurl, endpoint), json=payload)
print(result.json())

Este script activa una versión específica de un EdgeWorker en la red de ensayo.

2. Gestión de imágenes y vídeos

El Administrador de imágenes y vídeos (IVM) de Akamai se puede controlar a través de la API, lo que le permite optimizar y transformar los activos multimedia mediante programación:

endpoint = '/imaging/v0/policies'
result = session.get(urljoin(baseurl, endpoint))
policies = result.json()

for policy in policies['items']:
    print(f"Policy Name: {policy['name']}")
    print(f"Policy ID: {policy['id']}")
    print("---")

Este script recupera y muestra información sobre sus políticas de IVM.

3. Gestión de bots

El Administrador de bots de Akamai se puede configurar y supervisar a través de la API, lo que le permite ajustar mediante programación sus estrategias de detección y mitigación de bots:

endpoint = f'/appsec/v1/configs/{config_id}/versions/{version}/security-policies/{policy_id}/bot-management-settings'
result = session.get(urljoin(baseurl, endpoint))
bot_settings = result.json()

print(f"Bot Detection: {bot_settings['botDetectionEnabled']}")
print(f"Bot Management Mode: {bot_settings['botManagementSettings']['botManagementMode']}")

Este script recupera y muestra la configuración de gestión de bots para una política de seguridad específica.

Integración de la API de Akamai con Apidog

Si bien Akamai proporciona potentes herramientas para la gestión de API, la integración con plataformas de terceros como Apidog puede mejorar aún más su flujo de trabajo de desarrollo de API. Apidog ofrece un conjunto completo de herramientas para el diseño, las pruebas y la documentación de API.

Aquí le mostramos cómo puede aprovechar Apidog junto con la API de Akamai:

Documentación de la API: Utilice Apidog para crear documentación detallada e interactiva para sus integraciones de la API de Akamai. Esto puede ser especialmente útil para los equipos que trabajan en implementaciones complejas de Akamai.
Pruebas de solicitudes: Utilice las funciones de prueba de Apidog para validar sus solicitudes de la API de Akamai antes de implementarlas en su código. Esto puede ayudar a detectar problemas al principio del proceso de desarrollo.
Gestión del entorno: Gestione diferentes entornos (por ejemplo, ensayo, producción) para sus credenciales de la API de Akamai dentro de Apidog, lo que facilita el cambio entre ellos durante el desarrollo y las pruebas.
Colaboración: Aproveche las funciones de colaboración de Apidog para compartir las configuraciones de la API de Akamai y los resultados de las pruebas con los miembros de su equipo.
Servidores simulados: Utilice la funcionalidad del servidor simulado de Apidog para simular las respuestas de la API de Akamai durante el desarrollo, lo que le permite avanzar incluso cuando no tiene acceso inmediato al entorno de Akamai en vivo.

button

Para empezar a utilizar Apidog para sus proyectos de la API de Akamai:

Regístrese para obtener una cuenta de Apidog en apidog.com.
Cree un nuevo proyecto para su integración de la API de Akamai.
Importe sus especificaciones de la API de Akamai o créelas manualmente dentro de Apidog.
Configure los entornos para sus credenciales de la API de Akamai.
Empiece a crear y probar solicitudes de API utilizando la interfaz intuitiva de Apidog.

Al combinar la potencia de la API de Akamai con las herramientas integrales de desarrollo de API de Apidog, puede optimizar su flujo de trabajo y garantizar integraciones sólidas y bien documentadas.

Conclusión

La API de Akamai abre un mundo de posibilidades para los desarrolladores que buscan aprovechar la potencia de la red global y los servicios de Akamai mediante programación. Al dominar esta API, puede automatizar tareas complejas, integrar las capacidades de Akamai sin problemas en sus aplicaciones y crear soluciones personalizadas que aprovechen la infraestructura de Akamai para un rendimiento y una seguridad óptimos.

Recuerde seguir las mejores prácticas, mantenerse actualizado con la documentación de Akamai y considerar la posibilidad de integrar herramientas como Apidog para mejorar su proceso de desarrollo de API. Con el enfoque y las herramientas adecuados, puede aprovechar al máximo la API de Akamai para crear aplicaciones web más rápidas, seguras y altamente escalables.

A medida que continúe explorando e implementando la API de Akamai, no dude en experimentar con diferentes características y casos de uso. Cuanto más interactúe con la API, más valor podrá extraer de la potente plataforma de Akamai, lo que en última instancia conducirá a mejores experiencias para sus usuarios y a operaciones más eficientes para su organización.

button