API del sitio#

Lea y escriba el contenido de un sitio NAMES LEGAL por HTTPS: servicios, proyectos, entradas de blog, miembros del equipo, eventos, empleos, preguntas frecuentes y más. La API forma parte del add-on Acceso API del sitio.

Inicio rápido#

1. En la consola del sitio, Complementos y suscripción: active Acceso API.
2. Módulos → API: cree una clave. Cópiela ahora: se muestra una sola vez.
3. Llame a la API:

KEY="nlk_3fa9c2d1_Jx0..."
curl -H "Authorization: Api-Key $KEY" "https://ecolehorizon.names.legal/api/v1/team/?lang=fr"

{
  "count": 12,
  "next": "https://ecolehorizon.names.legal/api/v1/team/?lang=fr&page=2",
  "previous": null,
  "results": [
    {"id": 4, "first_name": "Awa", "last_name": "Diop", "position": "Mathematics teacher",
     "profile_image": "https://ecolehorizon.names.legal/media/demo/team/awa.jpg",
     "updated_at": "2026-09-20T08:12:44+02:00"}
  ]
}

URL base#

https://<site>/api/v1/

<site> es la dirección propia del sitio (ecolehorizon.names.legal o su dominio personalizado). No hay prefijo de idioma en la ruta. v1 es la única versión; un cambio incompatible llegaría como v2 junto a ella.

La URL raíz lista todas las colecciones. Una referencia interactiva (Swagger) y el esquema OpenAPI están disponibles en cada sitio:

Autenticación#

1. El propietario del sitio activa el add-on Acceso API.
2. En la consola, Módulos → API, crea una clave y elige su alcance. La clave completa se muestra una sola vez; solo se almacenan un prefijo y un hash.
3. Envíe la clave con cada solicitud.

GET /api/v1/services/ HTTP/1.1
Host: ecolehorizon.names.legal
Authorization: Api-Key nlk_3fa9c2d1_Jx0...

Authorization: Bearer <key> y X-Api-Key: <key> también se aceptan. Las claves tienen el formato nlk_<8 caracteres hexadecimales>_<secreto>.

Alcances#

El alcance se aplica a toda la clave; no existe un alcance por colección. Una clave puede revocarse en cualquier momento desde la consola.

Errores que puede encontrar#

Idioma#

Los campos traducidos se devuelven en un idioma a la vez. Elíjalo con ?lang=:

curl -H "Authorization: Api-Key $KEY" "https://ecolehorizon.names.legal/api/v1/services/?lang=fr"

El idioma debe ser uno de los idiomas publicados por el sitio; de lo contrario la respuesta es 400. Sin lang, se usa el idioma predeterminado del sitio. La respuesta incluye un encabezado Content-Language.

Paginación, filtros y ordenación#

Las listas están paginadas por número de página:

{
  "count": 42,
  "next": "https://ecolehorizon.names.legal/api/v1/team/?page=2",
  "previous": null,
  "results": [ ... ]
}

since hace que la sincronización incremental sea económica: guarde la hora de su última llamada y pásela la próxima vez.

Límites de solicitudes#

• 120 solicitudes por minuto y por clave API (cada clave tiene su propio contador).
• Sesiones de consola: 120 por minuto. Llamadas anónimas: 30 por minuto.

Superado el límite, la API responde 429; espere y reintente.

Colecciones#

Cada ficha es accesible en <collection>/<id>/. Los campos de cada colección están listados en la referencia siguiente.

Escritura#

• POST crea, PUT reemplaza, PATCH actualiza algunos campos.
• Las categorías se leen como un objeto {"id", "name", "slug"} y se escriben con category_slug. Un slug desconocido se rechaza.
• Las imágenes y los archivos son de solo lectura en la API: súbalos en la consola, o deje que el conector de datos los descargue desde una URL.
• El HTML enviado en campos de texto enriquecido se limpia: se eliminan scripts y manejadores de eventos.

curl -X POST "https://ecolehorizon.names.legal/api/v1/faq/?lang=fr" \
  -H "Authorization: Api-Key $KEY" -H "Content-Type: application/json" \
  -d '{"question": "Quand ont lieu les inscriptions ?", "answer": "<p>Du 1er au 30 juin.</p>"}'

Reservar una cita#

curl -X POST "https://ecolehorizon.names.legal/api/v1/bookings/" \
  -H "Authorization: Api-Key $KEY" -H "Content-Type: application/json" \
  -d '{"item": 3, "customer_name": "Awa Diop", "customer_email": "awa@example.com",
       "date": "2026-10-02", "time": "14:30"}'

time está en la zona horaria del sitio. Un horario que ya no esté disponible se rechaza con 400. Las nuevas reservas comienzan como pending.

Recetas#

Sincronizar una colección de forma incremental#

Lea todo una vez, luego solo lo que haya cambiado. Guarde la hora de su ejecución anterior y páselo como since.

Python

import time
import requests

BASE = "https://ecolehorizon.names.legal/api/v1/"
HEADERS = {"Authorization": "Api-Key nlk_3fa9c2d1_Jx0..."}

def fetch_all(collection, since=None, lang="fr"):
    url = f"{BASE}{collection}/"
    params = {"lang": lang, "page_size": 100, "ordering": "updated_at"}
    if since:
        params["since"] = since
    while url:
        response = requests.get(url, headers=HEADERS, params=params, timeout=15)
        if response.status_code == 429:
            time.sleep(int(response.headers.get("Retry-After", "5")))
            continue
        response.raise_for_status()
        data = response.json()
        yield from data["results"]
        url, params = data["next"], None   # "next" already carries the parameters

for member in fetch_all("team", since="2026-09-01T00:00:00Z"):
    print(member["id"], member["first_name"], member["last_name"])

JavaScript (Node.js 18+)

const BASE = "https://ecolehorizon.names.legal/api/v1/";
const HEADERS = { Authorization: "Api-Key nlk_3fa9c2d1_Jx0..." };

async function* fetchAll(collection, since, lang = "fr") {
  const first = new URL(`${BASE}${collection}/`);
  first.search = new URLSearchParams({ lang, page_size: "100", ordering: "updated_at",
                                       ...(since ? { since } : {}) });
  let url = first.toString();
  while (url) {
    const response = await fetch(url, { headers: HEADERS });
    if (response.status === 429) {
      const wait = Number(response.headers.get("Retry-After") || 5);
      await new Promise((resolve) => setTimeout(resolve, wait * 1000));
      continue;
    }
    if (!response.ok) throw new Error(`${response.status} ${await response.text()}`);
    const data = await response.json();
    yield* data.results;
    url = data.next;
  }
}

for await (const post of fetchAll("blog", "2026-09-01T00:00:00Z")) {
  console.log(post.id, post.title);
}

Crear o actualizar una ficha#

PHP

<?php
$base = 'https://ecolehorizon.names.legal/api/v1/';
$headers = ['Authorization: Api-Key nlk_3fa9c2d1_Jx0...', 'Content-Type: application/json'];

function call($method, $url, $headers, $body = null) {
    $ch = curl_init($url);
    curl_setopt_array($ch, [CURLOPT_CUSTOMREQUEST => $method, CURLOPT_HTTPHEADER => $headers,
                            CURLOPT_RETURNTRANSFER => true, CURLOPT_TIMEOUT => 15]);
    if ($body !== null) curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($body));
    $answer = curl_exec($ch);
    $status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
    curl_close($ch);
    return [$status, json_decode($answer, true)];
}

// Create an event (in French)
[$status, $event] = call('POST', $base . 'events/?lang=fr', $headers, [
    'title' => 'Journée portes ouvertes',
    'slug' => 'journee-portes-ouvertes-2026',
    'description' => '<p>Visite du campus et rencontre avec les enseignants.</p>',
    'start_date' => '2026-11-14T09:00:00+01:00',
    'end_date' => '2026-11-14T16:00:00+01:00',
    'location' => 'Campus de Genève',
]);

// Change only the location later
call('PATCH', $base . "events/{$event['id']}/?lang=fr", $headers, ['location' => 'Aula']);

lang decide en qué idioma se escribe un campo traducido: envíe la misma ficha de nuevo con ?lang=en para añadir la versión en inglés.

Errores y límites en la práctica#

Referencia por colección#

Generada a partir del código de la API: los campos, los derechos de acceso y los parámetros de consulta son siempre los de la plataforma en ejecución. Los campos traducidos se leen y escriben en el idioma elegido con lang.

/api/v1/services/

GETPOSTPUTPATCH

• Filtros slug category__slug is_featured
• search title description
• ordering order title updated_at (por defecto order)

/api/v1/projects/

GETPOSTPUTPATCH

• Filtros slug category__slug status is_featured
• search title description client technologies
• ordering order title project_date updated_at (por defecto order)

/api/v1/blog/

GETPOSTPUTPATCH

• Filtros slug category__slug status tags__slug
• search title excerpt content
• ordering published_date title updated_at (por defecto -published_date)

/api/v1/team/

GETPOSTPUTPATCH

• Filtros member_type is_featured
• search first_name last_name position specialties
• ordering order last_name updated_at (por defecto order)

/api/v1/testimonials/

GETPOSTPUTPATCH

• Filtros rating
• search name position testimonial
• ordering order rating updated_at (por defecto order)

/api/v1/publications/

GETPOSTPUTPATCH

• Filtros slug category__slug year is_featured
• search title authors journal abstract
• ordering order year title updated_at (por defecto order,-year)

/api/v1/resources/

GETPOSTPUTPATCH

• Filtros slug resource_type is_free
• search title description
• ordering order title created_at updated_at (por defecto order)

/api/v1/events/

GETPOSTPUTPATCH

• Filtros slug event_type is_online is_featured
• search title description location
• ordering start_date title updated_at (por defecto -start_date)

/api/v1/jobs/

GETPOSTPUTPATCH

• Filtros slug category__slug contract_type remote_option experience_level is_featured is_urgent
• search title description location skills_required
• ordering published_date title updated_at (por defecto -published_date)

/api/v1/faq/

GETPOSTPUTPATCH

• Filtros category__slug is_featured
• search question answer
• ordering order updated_at (por defecto order)

/api/v1/bookable-items/

GET

/api/v1/bookings/

POST

Recomendaciones de seguridad#

• Mantenga las claves en su servidor. Nunca incluya una clave en una aplicación móvil ni en código de navegador.
• Use una clave read siempre que no necesite escribir.
• Una clave por integración: revocar una no afecta a las demás.