API do site#

Leia e escreva o conteúdo de um site NAMES LEGAL através de HTTPS: serviços, projetos, publicações do blog, membros da equipa, eventos, ofertas de emprego, FAQ e muito mais. A API faz parte do add-on Acesso API do site.

Início rápido#

1. Na consola do site, em Módulos e subscrição: ative Acesso API.
2. Módulos → API: crie uma chave. Copie-a agora — é mostrada apenas uma vez.
3. Chame a 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> é o próprio endereço do site (ecolehorizon.names.legal ou o seu domínio personalizado). Não existe prefixo de idioma no caminho. v1 é a única versão; uma alteração de rutura surgiria como v2 em paralelo.

O URL raiz lista todas as coleções. Uma referência interativa (Swagger) e o esquema OpenAPI estão disponíveis em cada site:

Autenticação#

1. O proprietário do site ativa o add-on Acesso API.
2. Na consola, em Módulos → API, cria uma chave e escolhe o seu âmbito. A chave completa é mostrada uma única vez; apenas um prefixo e um hash são armazenados.
3. Envie a chave em cada pedido.

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

Authorization: Bearer <key> e X-Api-Key: <key> também são aceites. As chaves têm o formato nlk_<8 caracteres hexadecimais>_<secret>.

Âmbitos#

O âmbito aplica-se à chave inteira; não existe um âmbito por coleção. Uma chave pode ser revogada a qualquer momento a partir da consola.

Erros que pode encontrar#

Idioma#

Os campos traduzidos são devolvidos num único idioma de cada vez. Escolha-o com ?lang=:

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

O idioma tem de ser um dos idiomas publicados pelo site; caso contrário, a resposta é 400. Sem lang, é utilizado o idioma predefinido do site. A resposta inclui um cabeçalho Content-Language.

Paginação, filtros e ordenação#

As listas são paginadas por número de página:

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

since torna a sincronização incremental económica: guarde o momento da última chamada e passe-o na chamada seguinte.

Limites de pedidos#

• 120 pedidos por minuto por chave de API (cada chave tem o seu próprio contador).
• Sessões de consola: 120 por minuto. Chamadas anónimas: 30 por minuto.

Acima do limite, a API responde 429; aguarde e tente novamente.

Coleções#

Cada ficha está acessível em <collection>/<id>/. Os campos de cada coleção estão listados na referência abaixo.

Escrita#

• POST cria, PUT substitui, PATCH atualiza alguns campos.
• As categorias são lidas como um objeto {"id", "name", "slug"} e escritas com category_slug. Um slug desconhecido é recusado.
• As imagens e os ficheiros são só de leitura na API: carregue-os na consola, ou deixe o conector de dados transferi-los a partir de um URL.
• O HTML enviado em campos de texto formatado é limpo: scripts e manipuladores de eventos são removidos.

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>"}'

Marcar um compromisso#

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á no fuso horário do site. Um horário que já não esteja livre é recusado com 400. As novas marcações começam como pending.

Receitas#

Sincronizar uma coleção de forma incremental#

Leia tudo uma vez e depois apenas o que mudou. Guarde o momento da execução anterior e passe-o 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);
}

Criar ou atualizar uma 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 em que idioma um campo traduzido é escrito: envie a mesma ficha novamente com ?lang=en para adicionar a versão em inglês.

Erros e limites na prática#

Referência por coleção#

Gerada a partir do código da API: os campos, os direitos de acesso e os parâmetros de consulta são sempre os da plataforma em execução. Os campos traduzidos são lidos e escritos no idioma escolhido com lang.

/api/v1/services/

GETPOSTPUTPATCH

• Filtros slug category__slug is_featured
• search title description
• ordering order title updated_at (predefinição order)

/api/v1/projects/

GETPOSTPUTPATCH

• Filtros slug category__slug status is_featured
• search title description client technologies
• ordering order title project_date updated_at (predefinição order)

/api/v1/blog/

GETPOSTPUTPATCH

• Filtros slug category__slug status tags__slug
• search title excerpt content
• ordering published_date title updated_at (predefinição -published_date)

/api/v1/team/

GETPOSTPUTPATCH

• Filtros member_type is_featured
• search first_name last_name position specialties
• ordering order last_name updated_at (predefinição order)

/api/v1/testimonials/

GETPOSTPUTPATCH

• Filtros rating
• search name position testimonial
• ordering order rating updated_at (predefinição order)

/api/v1/publications/

GETPOSTPUTPATCH

• Filtros slug category__slug year is_featured
• search title authors journal abstract
• ordering order year title updated_at (predefinição order,-year)

/api/v1/resources/

GETPOSTPUTPATCH

• Filtros slug resource_type is_free
• search title description
• ordering order title created_at updated_at (predefinição order)

/api/v1/events/

GETPOSTPUTPATCH

• Filtros slug event_type is_online is_featured
• search title description location
• ordering start_date title updated_at (predefinição -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 (predefinição -published_date)

/api/v1/faq/

GETPOSTPUTPATCH

• Filtros category__slug is_featured
• search question answer
• ordering order updated_at (predefinição order)

/api/v1/bookable-items/

GET

/api/v1/bookings/

POST

Recomendações de segurança#

• Mantenha as chaves no seu servidor. Nunca inclua uma chave numa aplicação móvel ou em código do browser.
• Utilize uma chave read sempre que não seja necessário escrever.
• Uma chave por integração: revogar uma não afeta as outras.