2. Cómo empezar

En esta sección, te explicaremos cómo empezar a certificar archivos con nuestra aplicación.

2.1. Requisitos

Necesitas tener una cuenta de usuario en la plataforma Code Contract. Si aún no tienes una cuenta, puedes ponte en contacto con nosotros aquí. Una vez que tengas tu cuenta, podrás enviar los datos vía API a la aplicación. Para eso son necesarios 3 pasos:

2.2. Primeros pasos

2.2.1. Iniciar sesión

Es necesario iniciar sesión para obtener un token que te permita acceder a los distintos servicios de la aplicación. El token es una cadena de caracteres que identifica y autoriza tu sesión. Para iniciar sesión, debes enviar una petición POST al endpoint /login con tu nombre de usuario y contraseña. Si la petición es procesada con éxito, recibirás una respuesta con el token. Puedes ver un ejemplo de cómo hacerlo aquí.

• Petición por POST:

 curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/api/login"

• Cuerpo de la petición:

{
    email: string
    password: string
}

• Ejemplo:

{
    "email":  "example@mail.com",
    "password": "abc12345"
}

El token es una cadena de caracteres que identifica y autoriza tu sesión en la plataforma Code Contract. Para que las peticiones posteriores a los distintos servicios de la plataforma sean válidas, es necesario incluir el token en las cabeceras de las peticiones. De esta forma, se verifica que eres el usuario legítimo y que tienes permiso para acceder a los servicios solicitados.

• Ejemplo de token válido:

{
    token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
}

Para incluir el token en las cabeceras de las peticiones, debes usar el campo Authorization con el valor Bearer <token>, donde es el token que obtuviste al iniciar sesión. Por ejemplo, si tu token es eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..., la cabecera de la petición sería:

Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

2.2.2. Crear un proyecto

Un proyecto es un espacio en el cual se van a registrar los elementos a certificar.

Cuando creamos un proyecto estamos creando un contrato inteligente en la cadena de bloques.

Cada proyecto tiene un nombre, una descripción y un identificador único. Para crear un proyecto, debes enviar una petición POST al endpoint /smart-check/new-smart-check-merkle con el token de tu sesión y los datos del proyecto. Si la petición es exitosa, recibirás una respuesta con los datos de indentificación del proyecto creado. Puedes ver un ejemplo de cómo hacerlo aquí.

• Petición POST:

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/api/smart-check/new-smart-check-merkle"

• Cuerpo de la petición

{
    description: string
}

• Ejemplo:

{
    "description": "Votaciones Comunidad de vecinos"
}

• Ejemplo de respuesta válida:

{
    date_creation: 2023-01-12 12:42:55 UTC
    description: Votaciones Comunidad de vecinos
    oid: 63c0004fb48e545d74c2851d
    owner: 62de6c3fc962a7dc80c644b5
    state: CREATING
}

Campo	Tipo	Descripción
date_creation	string	Fecha de creación del proyecto.
description	string	Descripción facilitada en el momento de la creación.
oid	string	Código identificador del proyecto.
owner	string	Código identificador del propietario o creador del proyecto.
state	string	Estado actual del proyecto.