Introducción

En esta plataforma encontrarás algunos servicios que se pueden usar directamente desde tu panel una vez que tengas tu cuenta:

  • Correos transaccionales
  • Optimización de imágenes
  • Almacenamiento de archivos
  • Generación de PDF
  • Acortador de URL

Estos servicios también ofrecen una API REST para interactuar con ellos desde cualquier otro sistema que pueda realizar solicitudes HTTP.

Empezar

Activar servicios

Antes de utilizar la API de un servicio, es necesario que lo actives en su respectiva página.

Páginas de los servicios:

Crear API keys

En cada página de servicio encontrarás un acordeón con la leyenda "API key", al hacer clic sobre él verás el botón "Crear API key".

Headers

A continuación se muestran las cabeceras necesarias para usar la API.

Authorization

typescript
	
	/*...*/
	// La API key sólo debe existir en el servidor.
	Authorization: `Bearer ${API_KEY}`,
	/*...*/

Todas las solicitudes autenticadas deben realizarse desde tu servidor e incluir esta cabecera. Su valor se compone de la palabra "Bearer" seguida por tu API key y separada por un espacio. Nunca expongas la credencial en código enviado al navegador.

Content-Type

typescript
	
	/*...*/
	// Usa este tipo para cuerpos JSON.
	'Content-Type': 'application/json'
	/*...*/

Cuando se requiera enviar datos en el body de la solicitud, esta cabecera será necesaria y deberá contener el valor "application/json".

Accept-Language

typescript
	
	/*...*/
	// Opcional: solicita mensajes de error en español.
	'Accept-Language': 'es',
	/*...*/

Usar esta cabecera con el valor "es" hará que los mensajes de error en las respuestas de la API estén en español. Utilizar cualquier otro valor o no enviar ninguno hará que todos estos mensajes estén en inglés.