Módulo 1. Hola Mundo
Módulo 2. Programando la web
Módulo 3. React
Proyectos
Formación continua
Guías

Anexo. Documentación del API de Awesome Profile Cards

API del back-end

La URL base del servicio es

https://us-central1-awesome-cards-cf6f0.cloudfunctions.net/

El API sigue una convención tipo REST para la gestión de tarjetas: creación y acceso a las mismas. Las acciones implementadas por este API son las siguientes:

  • CREATE: una petición 'POST' a la URL /card con los datos necesarios en formato JSON (especificados más abajo) creará una nueva tarjeta

  • GET: una petición 'GET' a la URL /card/:id:/ devuelve una página web en HTML donde se muestran los datos de la tarjeta con el identificador 'id'

En el proyecto 2 de Adalab vamos a usar el servicio para crear una tarjeta. El servicio de acceder a una tarjeta (GET) lo usamos indirectamente porque lo usa la URL que nos devuelve el servicio de crear una tarjeta.

Datos necesarios para crear una tarjeta

Todos los campos son obligatorios, excepto el teléfono.

  • Paleta colores

    • Nombre del campo: palette

    • Descripción: número que representa la paleta elegida, de 1 a 3

    • Ejemplo: 1

  • Nombre

    • Nombre del campo: name

    • Descripción: nombre completo

    • Ejemplo: María García

  • Profesión

    • Nombre del campo: job

    • Descripción: profesión

    • Ejemplo: Programadora front-end

  • Teléfono

    • Nombre del campo: phone

    • Descripción: teléfono

    • Ejemplo: +34 666666666

  • Email

    • Nombre del campo: email

    • Descripción: email

    • Ejemplo: maria.garcia@example.com

  • LinkedIn

    • Nombre del campo: linkedin

    • Descripción: nombre de usuario de LinkedIn

    • Ejemplo: mariagar

  • GitHub

    • Nombre del campo: github

    • Descripción: nombre de usuario de GitHub

    • Ejemplo: mariagar

  • Foto

    • Nombre del campo: photo

    • Descripción: foto en codificación base64 (la que obtenemos al hacer FileReader.readAsDataURL)

Ejemplo de JSON completo:

{
"palette": 1,
"name": "María García",
"job": "Front-end developer",
"phone": "+34 666666666",
"email": "mariagar@example.com",
"linkedin": "mariagar",
"github": "mariagar",
"photo": "data:image/png;base64,2342ba..."
}

Formato de respuestas

La respuesta que da el API tiene el siguiente formato si todo ha ido bien:

{
"success": true,
"cardURL": "https://us-central1-awesome-cards-cf6f0.cloudfunctions.net/card/${cardId}"
}

Si hay algún error, la respuesta tiene esta pinta:

{
"success": false,
"error": "Error description"
}

Ejemplo de uso

Proporcionamos un ejemplo de uso del servicio en este codepen.