Primeros Pasos

Esta guía te muestra las operaciones básicas de KVNode: verificación de salud, gestión de colecciones y operaciones con clave-valor.

Verificación de Salud

Verifica que el nodo esté funcionando:

curl "https://api.hola.cloud/healthz"

GET /healthz HTTP/1.1
Host: api.hola.cloud

package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	req, err := http.NewRequest("GET", "https://api.hola.cloud/healthz", nil)
	if err != nil {
		panic(err)
	}

	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()

	responseBody, err := io.ReadAll(resp.Body)
	if err != nil {
		panic(err)
	}
	fmt.Println(string(responseBody))
}

<?php
$ch = curl_init();

curl_setopt_array($ch, [
    CURLOPT_URL => 'https://api.hola.cloud/healthz',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'GET',
]);

$response = curl_exec($ch);
if ($response === false) {
    throw new Exception(curl_error($ch));
}
curl_close($ch);

echo $response;

import requests

response = requests.request(
    "GET",
    "https://api.hola.cloud/healthz"
)

print(response.text)

const response = await fetch("https://api.hola.cloud/healthz", {
  method: "GET"
});

console.log(await response.text());

const response = await fetch("https://api.hola.cloud/healthz", {
  method: "GET"
});

const text = await response.text();
console.log(text);

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
    public static void main(String[] args) throws Exception {
        var request = HttpRequest.newBuilder()
            .uri(URI.create("https://api.hola.cloud/healthz"))
            .method("GET", HttpRequest.BodyPublishers.noBody())
            .build();

        var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.body());
    }
}

Respuesta esperada:

1{"ok":true,"node":"node-1","role":"primary"}

Verificación de Disponibilidad

Comprueba si el nodo está listo para recibir tráfico (verifica la conexión con el nodo padre en réplicas):

curl "https://api.hola.cloud/readyz"

GET /readyz HTTP/1.1
Host: api.hola.cloud

package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	req, err := http.NewRequest("GET", "https://api.hola.cloud/readyz", nil)
	if err != nil {
		panic(err)
	}

	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()

	responseBody, err := io.ReadAll(resp.Body)
	if err != nil {
		panic(err)
	}
	fmt.Println(string(responseBody))
}

<?php
$ch = curl_init();

curl_setopt_array($ch, [
    CURLOPT_URL => 'https://api.hola.cloud/readyz',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'GET',
]);

$response = curl_exec($ch);
if ($response === false) {
    throw new Exception(curl_error($ch));
}
curl_close($ch);

echo $response;

import requests

response = requests.request(
    "GET",
    "https://api.hola.cloud/readyz"
)

print(response.text)

const response = await fetch("https://api.hola.cloud/readyz", {
  method: "GET"
});

console.log(await response.text());

const response = await fetch("https://api.hola.cloud/readyz", {
  method: "GET"
});

const text = await response.text();
console.log(text);

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
    public static void main(String[] args) throws Exception {
        var request = HttpRequest.newBuilder()
            .uri(URI.create("https://api.hola.cloud/readyz"))
            .method("GET", HttpRequest.BodyPublishers.noBody())
            .build();

        var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.body());
    }
}

Respuesta esperada cuando está listo:

1{"ok":true,"node":"node-1","role":"primary","ready":true,"checks":{"wal_replayed":true,"parent_connected":true}}

Crear una Colección

Las colecciones son contenedores de pares clave-valor. Crea una con una solicitud POST:

curl -X POST "https://api.hola.cloud/v1/collections" \
  -H "apikey: tu-api-key" \
  -H "secret: tu-api-secret" \
  -d '{"name": "mi-coleccion"}'

POST /v1/collections HTTP/1.1
Host: api.hola.cloud
apikey: tu-api-key
secret: tu-api-secret

{"name": "mi-coleccion"}

package main

import (
	"fmt"
	"io"
	"net/http"
	"encoding/json"
	"strings"
)

func main() {
	payload := map[string]any{"name": "mi-coleccion"}
	bodyBytes, err := json.Marshal(payload)
	if err != nil {
		panic(err)
	}
	body := string(bodyBytes)

	req, err := http.NewRequest("POST", "https://api.hola.cloud/v1/collections", strings.NewReader(body))
	if err != nil {
		panic(err)
	}
	req.Header.Set("apikey", "tu-api-key")
	req.Header.Set("secret", "tu-api-secret")

	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()

	responseBody, err := io.ReadAll(resp.Body)
	if err != nil {
		panic(err)
	}
	fmt.Println(string(responseBody))
}

<?php
$payload = ['name' => 'mi-coleccion'];
$body = json_encode($payload);

$ch = curl_init();

curl_setopt_array($ch, [
    CURLOPT_URL => 'https://api.hola.cloud/v1/collections',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS => $body,
    CURLOPT_HTTPHEADER => [
        'apikey: tu-api-key',
        'secret: tu-api-secret',
    ],
]);

$response = curl_exec($ch);
if ($response === false) {
    throw new Exception(curl_error($ch));
}
curl_close($ch);

echo $response;

import requests

import json

headers = {
    "apikey": "tu-api-key",
    "secret": "tu-api-secret",
}

payload = {"name": "mi-coleccion"}
body = json.dumps(payload)

response = requests.request(
    "POST",
    "https://api.hola.cloud/v1/collections",
    headers=headers,
    data=body
)

print(response.text)

const payload = {"name": "mi-coleccion"};

const response = await fetch("https://api.hola.cloud/v1/collections", {
  method: "POST",
  headers: {
    "apikey": "tu-api-key",
    "secret": "tu-api-secret"
  },
  body: JSON.stringify(payload)
});

console.log(await response.text());

const payload = {"name": "mi-coleccion"};

const response = await fetch("https://api.hola.cloud/v1/collections", {
  method: "POST",
  headers: {
    "apikey": "tu-api-key",
    "secret": "tu-api-secret"
  },
  body: JSON.stringify(payload)
});

const text = await response.text();
console.log(text);

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import com.fasterxml.jackson.databind.ObjectMapper;
import java.util.Map;
import java.util.List;

public class Main {
    public static void main(String[] args) throws Exception {
        var payload = Map.of("name", "mi-coleccion");
        var body = new ObjectMapper().writeValueAsString(payload);

        var request = HttpRequest.newBuilder()
            .uri(URI.create("https://api.hola.cloud/v1/collections"))
            .method("POST", HttpRequest.BodyPublishers.ofString(body))
            .header("apikey", "tu-api-key")
            .header("secret", "tu-api-secret")
            .build();

        var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.body());
    }
}

Respuesta esperada:

1{"ok":true,"collection":"mi-coleccion"}

Establecer un Par Clave-Valor

Almacena un valor JSON bajo una clave dentro de una colección:

curl -X POST "https://api.hola.cloud/v1/collections/mi-coleccion/keys/usuario:alice" \
  -H "apikey: tu-api-key" \
  -H "secret: tu-api-secret" \
  -d '{"value": {"usuario": "alice", "rol": "admin"}}'

POST /v1/collections/mi-coleccion/keys/usuario:alice HTTP/1.1
Host: api.hola.cloud
apikey: tu-api-key
secret: tu-api-secret

{"value": {"usuario": "alice", "rol": "admin"}}

package main

import (
	"fmt"
	"io"
	"net/http"
	"encoding/json"
	"strings"
)

func main() {
	payload := map[string]any{"value": map[string]any{"rol": "admin", "usuario": "alice"}}
	bodyBytes, err := json.Marshal(payload)
	if err != nil {
		panic(err)
	}
	body := string(bodyBytes)

	req, err := http.NewRequest("POST", "https://api.hola.cloud/v1/collections/mi-coleccion/keys/usuario:alice", strings.NewReader(body))
	if err != nil {
		panic(err)
	}
	req.Header.Set("apikey", "tu-api-key")
	req.Header.Set("secret", "tu-api-secret")

	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()

	responseBody, err := io.ReadAll(resp.Body)
	if err != nil {
		panic(err)
	}
	fmt.Println(string(responseBody))
}

<?php
$payload = ['value' => ['rol' => 'admin', 'usuario' => 'alice']];
$body = json_encode($payload);

$ch = curl_init();

curl_setopt_array($ch, [
    CURLOPT_URL => 'https://api.hola.cloud/v1/collections/mi-coleccion/keys/usuario:alice',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS => $body,
    CURLOPT_HTTPHEADER => [
        'apikey: tu-api-key',
        'secret: tu-api-secret',
    ],
]);

$response = curl_exec($ch);
if ($response === false) {
    throw new Exception(curl_error($ch));
}
curl_close($ch);

echo $response;

import requests

import json

headers = {
    "apikey": "tu-api-key",
    "secret": "tu-api-secret",
}

payload = {"value": {"rol": "admin", "usuario": "alice"}}
body = json.dumps(payload)

response = requests.request(
    "POST",
    "https://api.hola.cloud/v1/collections/mi-coleccion/keys/usuario:alice",
    headers=headers,
    data=body
)

print(response.text)

const payload = {"value": {"rol": "admin", "usuario": "alice"}};

const response = await fetch("https://api.hola.cloud/v1/collections/mi-coleccion/keys/usuario:alice", {
  method: "POST",
  headers: {
    "apikey": "tu-api-key",
    "secret": "tu-api-secret"
  },
  body: JSON.stringify(payload)
});

console.log(await response.text());

const payload = {"value": {"rol": "admin", "usuario": "alice"}};

const response = await fetch("https://api.hola.cloud/v1/collections/mi-coleccion/keys/usuario:alice", {
  method: "POST",
  headers: {
    "apikey": "tu-api-key",
    "secret": "tu-api-secret"
  },
  body: JSON.stringify(payload)
});

const text = await response.text();
console.log(text);

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import com.fasterxml.jackson.databind.ObjectMapper;
import java.util.Map;
import java.util.List;

public class Main {
    public static void main(String[] args) throws Exception {
        var payload = Map.of("value", Map.of("rol", "admin", "usuario", "alice"));
        var body = new ObjectMapper().writeValueAsString(payload);

        var request = HttpRequest.newBuilder()
            .uri(URI.create("https://api.hola.cloud/v1/collections/mi-coleccion/keys/usuario:alice"))
            .method("POST", HttpRequest.BodyPublishers.ofString(body))
            .header("apikey", "tu-api-key")
            .header("secret", "tu-api-secret")
            .build();

        var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.body());
    }
}

Respuesta esperada:

1{"ok":true,"seq":1,"version":1}

Obtener una Clave

Recupera el valor de una clave específica:

curl "https://api.hola.cloud/v1/collections/mi-coleccion/keys/usuario:alice" \
  -H "apikey: tu-api-key" \
  -H "secret: tu-api-secret"

GET /v1/collections/mi-coleccion/keys/usuario:alice HTTP/1.1
Host: api.hola.cloud
apikey: tu-api-key
secret: tu-api-secret

package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	req, err := http.NewRequest("GET", "https://api.hola.cloud/v1/collections/mi-coleccion/keys/usuario:alice", nil)
	if err != nil {
		panic(err)
	}
	req.Header.Set("apikey", "tu-api-key")
	req.Header.Set("secret", "tu-api-secret")

	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()

	responseBody, err := io.ReadAll(resp.Body)
	if err != nil {
		panic(err)
	}
	fmt.Println(string(responseBody))
}

<?php
$ch = curl_init();

curl_setopt_array($ch, [
    CURLOPT_URL => 'https://api.hola.cloud/v1/collections/mi-coleccion/keys/usuario:alice',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_HTTPHEADER => [
        'apikey: tu-api-key',
        'secret: tu-api-secret',
    ],
]);

$response = curl_exec($ch);
if ($response === false) {
    throw new Exception(curl_error($ch));
}
curl_close($ch);

echo $response;

import requests

headers = {
    "apikey": "tu-api-key",
    "secret": "tu-api-secret",
}

response = requests.request(
    "GET",
    "https://api.hola.cloud/v1/collections/mi-coleccion/keys/usuario:alice",
    headers=headers
)

print(response.text)

const response = await fetch("https://api.hola.cloud/v1/collections/mi-coleccion/keys/usuario:alice", {
  method: "GET",
  headers: {
    "apikey": "tu-api-key",
    "secret": "tu-api-secret"
  }
});

console.log(await response.text());

const response = await fetch("https://api.hola.cloud/v1/collections/mi-coleccion/keys/usuario:alice", {
  method: "GET",
  headers: {
    "apikey": "tu-api-key",
    "secret": "tu-api-secret"
  }
});

const text = await response.text();
console.log(text);

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
    public static void main(String[] args) throws Exception {
        var request = HttpRequest.newBuilder()
            .uri(URI.create("https://api.hola.cloud/v1/collections/mi-coleccion/keys/usuario:alice"))
            .method("GET", HttpRequest.BodyPublishers.noBody())
            .header("apikey", "tu-api-key")
            .header("secret", "tu-api-secret")
            .build();

        var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.body());
    }
}

Respuesta esperada:

1{"key":"usuario:alice","value":{"usuario":"alice","rol":"admin"},"version":1,"updatedAt":"2025-01-01T00:00:00Z"}

Listar Claves con Prefijo

Lista todas las claves en una colección, opcionalmente filtradas por prefijo y limitadas en cantidad:

curl "https://api.hola.cloud/v1/collections/mi-coleccion/keys?prefix=usuario:&limit=10" \
  -H "apikey: tu-api-key" \
  -H "secret: tu-api-secret"

GET /v1/collections/mi-coleccion/keys?prefix=usuario:&limit=10 HTTP/1.1
Host: api.hola.cloud
apikey: tu-api-key
secret: tu-api-secret

package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	req, err := http.NewRequest("GET", "https://api.hola.cloud/v1/collections/mi-coleccion/keys?prefix=usuario:&limit=10", nil)
	if err != nil {
		panic(err)
	}
	req.Header.Set("apikey", "tu-api-key")
	req.Header.Set("secret", "tu-api-secret")

	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()

	responseBody, err := io.ReadAll(resp.Body)
	if err != nil {
		panic(err)
	}
	fmt.Println(string(responseBody))
}

<?php
$ch = curl_init();

curl_setopt_array($ch, [
    CURLOPT_URL => 'https://api.hola.cloud/v1/collections/mi-coleccion/keys?prefix=usuario:&limit=10',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_HTTPHEADER => [
        'apikey: tu-api-key',
        'secret: tu-api-secret',
    ],
]);

$response = curl_exec($ch);
if ($response === false) {
    throw new Exception(curl_error($ch));
}
curl_close($ch);

echo $response;

import requests

headers = {
    "apikey": "tu-api-key",
    "secret": "tu-api-secret",
}

response = requests.request(
    "GET",
    "https://api.hola.cloud/v1/collections/mi-coleccion/keys?prefix=usuario:&limit=10",
    headers=headers
)

print(response.text)

const response = await fetch("https://api.hola.cloud/v1/collections/mi-coleccion/keys?prefix=usuario:&limit=10", {
  method: "GET",
  headers: {
    "apikey": "tu-api-key",
    "secret": "tu-api-secret"
  }
});

console.log(await response.text());

const response = await fetch("https://api.hola.cloud/v1/collections/mi-coleccion/keys?prefix=usuario:&limit=10", {
  method: "GET",
  headers: {
    "apikey": "tu-api-key",
    "secret": "tu-api-secret"
  }
});

const text = await response.text();
console.log(text);

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
    public static void main(String[] args) throws Exception {
        var request = HttpRequest.newBuilder()
            .uri(URI.create("https://api.hola.cloud/v1/collections/mi-coleccion/keys?prefix=usuario:&limit=10"))
            .method("GET", HttpRequest.BodyPublishers.noBody())
            .header("apikey", "tu-api-key")
            .header("secret", "tu-api-secret")
            .build();

        var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.body());
    }
}

Respuesta esperada:

1[{"key":"usuario:alice","value":{"usuario":"alice","rol":"admin"},"version":1}]

Eliminar una Clave

Elimina una clave de una colección:

curl -X DELETE "https://api.hola.cloud/v1/collections/mi-coleccion/keys/usuario:alice" \
  -H "apikey: tu-api-key" \
  -H "secret: tu-api-secret"

DELETE /v1/collections/mi-coleccion/keys/usuario:alice HTTP/1.1
Host: api.hola.cloud
apikey: tu-api-key
secret: tu-api-secret

package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	req, err := http.NewRequest("DELETE", "https://api.hola.cloud/v1/collections/mi-coleccion/keys/usuario:alice", nil)
	if err != nil {
		panic(err)
	}
	req.Header.Set("apikey", "tu-api-key")
	req.Header.Set("secret", "tu-api-secret")

	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()

	responseBody, err := io.ReadAll(resp.Body)
	if err != nil {
		panic(err)
	}
	fmt.Println(string(responseBody))
}

<?php
$ch = curl_init();

curl_setopt_array($ch, [
    CURLOPT_URL => 'https://api.hola.cloud/v1/collections/mi-coleccion/keys/usuario:alice',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'DELETE',
    CURLOPT_HTTPHEADER => [
        'apikey: tu-api-key',
        'secret: tu-api-secret',
    ],
]);

$response = curl_exec($ch);
if ($response === false) {
    throw new Exception(curl_error($ch));
}
curl_close($ch);

echo $response;

import requests

headers = {
    "apikey": "tu-api-key",
    "secret": "tu-api-secret",
}

response = requests.request(
    "DELETE",
    "https://api.hola.cloud/v1/collections/mi-coleccion/keys/usuario:alice",
    headers=headers
)

print(response.text)

const response = await fetch("https://api.hola.cloud/v1/collections/mi-coleccion/keys/usuario:alice", {
  method: "DELETE",
  headers: {
    "apikey": "tu-api-key",
    "secret": "tu-api-secret"
  }
});

console.log(await response.text());

const response = await fetch("https://api.hola.cloud/v1/collections/mi-coleccion/keys/usuario:alice", {
  method: "DELETE",
  headers: {
    "apikey": "tu-api-key",
    "secret": "tu-api-secret"
  }
});

const text = await response.text();
console.log(text);

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
    public static void main(String[] args) throws Exception {
        var request = HttpRequest.newBuilder()
            .uri(URI.create("https://api.hola.cloud/v1/collections/mi-coleccion/keys/usuario:alice"))
            .method("DELETE", HttpRequest.BodyPublishers.noBody())
            .header("apikey", "tu-api-key")
            .header("secret", "tu-api-secret")
            .build();

        var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.body());
    }
}

Respuesta esperada:

1{"ok":true,"seq":2,"version":2}

Resumen

Has realizado las operaciones básicas de KVNode: verificación de salud, creación de colecciones y CRUD completo sobre pares clave-valor. A partir de aquí, explora la configuración de replicación y la integración con los SDKs multi-lenguaje.