Dokumentacja

Wszystko, czego potrzebujesz, by zacząć korzystać z API i serwera MCP. Pełna specyfikacja jest w dokumentacji referencyjnej.

Adres i dostęp

API działa pod adresem https://edu.ippe.uk. Nie wymaga rejestracji ani klucza; każda odpowiedź to JSON.

curl -s 'https://edu.ippe.uk/v1/curriculum/timeline?schoolType=szkola-podstawowa' \
  -H 'Accept-Language: pl'

Klucz API (nagłówek X-API-Key) podnosi limity zapytań. Bieżące limity są w nagłówkach RateLimit i RateLimit-Policy każdej odpowiedzi.

Konwencje

  • Rekordy mają identyfikatory źródłowe: numer RSPO szkoły, ELI aktu prawnego (np. DU/2026/378), kod TERC jednostki terytorialnej, symbol kwalifikacji z ZRK.
  • Odpowiedzi nie zależą od języka: teksty generowane przez platformę mają postać mapy z kluczami pl i en. Nagłówek Accept-Language wybiera tylko język komunikatów o błędach.
  • Listy są stronicowane kursorem: page.nextCursor oraz nagłówek Link z rel="next".
  • Każdy rekord ma pole provenance: źródło, datę pobrania, licencję i identyfikator migawki.
  • Odpowiedzi mają ETag i Cache-Control; zapytanie warunkowe z If-None-Match zwraca 304, gdy nic się nie zmieniło.

Czas: rok szkolny i data

Operacje dotyczące podstawy programowej przyjmują schoolYear (np. 2026/2027) albo asOf (datę). Bez nich obowiązuje bieżący rok szkolny, który zaczyna się 1 września. W okresie przejściowym różne klasy uczą się według różnych podstaw, dlatego zawsze podawaj klasę i rok.

Zobacz, jak zmienia się podstawa w kolejnych latach

Błędy

Błędy mają format RFC 9457 (application/problem+json): stały kod w polu code, informację, czy warto ponowić zapytanie, i identyfikator zapytania. Opisy błędów są po polsku albo po angielsku, zależnie od Accept-Language.

Katalog kodów błędów

Serwer MCP

Ten sam katalog operacji jest dostępny jako narzędzia MCP pod adresem https://edu.ippe.uk/mcp (Streamable HTTP, bez stanu). Narzędzia zwracają dane strukturalne i krótki opis tekstowy.

Claude Code

claude mcp add --transport http edu-hub https://edu.ippe.uk/mcp

Inne klienty MCP

{
  "mcpServers": {
    "edu-hub": {
      "type": "http",
      "url": "https://edu.ippe.uk/mcp"
    }
  }
}

Narzędzia i odpowiadające im operacje REST

Narzędzie MCPREST
edu_search_institutionsGET /v1/institutions
edu_get_institutionGET /v1/institutions/{rspo}
edu_search_territorial_unitsGET /v1/territorial-units
edu_search_legal_actsGET /v1/legal-acts
edu_get_legal_actGET /v1/legal-acts/{publisher}/{year}/{position}
edu_get_applicable_curriculumGET /v1/curriculum/applicable
edu_get_curriculum_timelineGET /v1/curriculum/timeline
edu_search_qualificationsGET /v1/qualifications
edu_get_qualificationGET /v1/qualifications/{symbol}
searchGET /v1/search
edu_list_data_sourcesGET /v1/sources
edu_list_reference_valuesGET /v1/reference-lists/{list}

Dokumentacja referencyjna