Crear Collection (POST)

Este servicio permite la creación de un Collection (en español, colecciones). Las colecciones se utilizan para organizar y almacenar conjuntos de imágenes faciales o datos con diversos fines.

Las colecciones son parte fundamental del proceso de gestión de registros biométricos y personas, así que es sumamente importante entender cómo crearlas y gestionarlas.

Verifik ofrece una guía sobre cómo crear y gestionar colecciones. Le invitamos a leerla: Guía Collection y Persons.

El servicio responderá con información sobre la colección recién creada, incluyendo su identificador único, nombre, descripción y marcas de tiempo. Puedes utilizar esta información para gestionar y organizar datos faciales dentro de la colección según sea necesario para tu aplicación.

¿Cómo usar un Collection?

Cuando una colección ha sido generada recibirá el siguiente JSON como response:

{
  "data": {
    "__v": 0,
    "_id": "65175da13e81e4fabc12345",
    "code": "dac2c81b-96a6-4f19-ab54-d1a72d55b64b",
    "name": "Test2",
    "client": "65175da13e81e4fabc12345",
    "deleted": false,
    "createdAt": "2023-09-29T23:28:33.894Z",
    "updatedAt": "2023-09-29T23:28:33.894Z",
    "description": "Test Collection"
  }
}

Si bien todos los anteriores parámetros son útiles, el que buscamos en este momento es code. Este parámetro será el que usaremos de ahora en adelante cuando se nos sea solicitado, el cual se asociará con el nombre collection_id:

{
    "code": "dac2c81b-96a6-4f19-ab54-d1a72d55b64b"
}

Implementación

Consulta

import axios from 'axios';

const options = {
  method: 'POST',
  url: '<https://api.verifik.co/v2/face-recognition/collections>',
  params: {
  },
  headers: {
    Accept: 'application/json',
    Authorization: 'jwt <tu_token>'
  },
    data: {name: 'string', description: 'string'}
};

try {
 notFou const { data } = await axios.request(options);
  console.log(data);
} catch (error) {
  console.error(error);
}

Respuesta 200 - (Consulta Exitosa)

{
  "data": {
    "__v": 0,
    "_id": "65175da13e81e4fabc12345",
    "code": "dac2c81b-96a6-4f19-ab54-d1a72d55b64b",
    "name": "Test2",
    "client": "65175da13e81e4fabc12345",
    "deleted": false,
    "createdAt": "2023-09-29T23:28:33.894Z",
    "updatedAt": "2023-09-29T23:28:33.894Z",
    "description": "Test Collection"
  }
}

Obtener Collections (GET)

Este servicio permite traer todas las colecciones generadas por un cliente en específico, como único parámetro se requiere enviar el access token, ya con esto Verifik identificara las colecciones generadas por este usuario.

Verifik ofrece una guía sobre cómo crear y gestionar colecciones. Le invitamos a leerla: Guía Collection y Persons.