Przegląd API - clarife

Czym jest API clarife

API clarife umożliwia programowy dostęp do Twojego konta - tworzenie dokumentów, zarządzanie projektami, konfigurowanie udostępnień i wiele więcej. Najważniejsze funkcje platformy są dostępne przez REST API.

Deweloperzy - Buduj integracje i automatyzacje z własnymi narzędziami.
Agenty AI - Podłącz Claude, GPT lub inne modele przez MCP lub REST.
Automatyzacja - Połącz clarife z n8n, Make, Zapier i innymi platformami.

Wymagania planowe

API jest dostępne na planach Pro i Business.

Funkcja	Pro	Business
Limit zapytań	100 req/min	500 req/min
Klucze API	do 5	do 20
Subskrypcje webhooków	do 3	do 20
Serwer MCP	tak	tak

ℹ️ Informacja: Plan Free nie ma dostępu do API. Zaktualizuj plan w Ustawienia > Rozliczenia.

Base URL

Wszystkie endpointy API znajdują się pod adresem:

https://my.clarife.app/api/v1

Szybki start

Krok 1 - Utwórz klucz API

Przejdź do Ustawienia > API i kliknij Utwórz klucz. Skopiuj klucz - zobaczysz go tylko raz.

Krok 2 - Wyślij pierwsze zapytanie

Sprawdź połączenie wywołując endpoint /me:

bash

curl -s https://my.clarife.app/api/v1/me \
  -H "Authorization: Bearer clrf_xxxxx" | jq

Krok 3 - Pobierz listę dokumentów

bash

curl -s "https://my.clarife.app/api/v1/documents?limit=5" \
  -H "Authorization: Bearer clrf_xxxxx" | jq

Format odpowiedzi

Wszystkie odpowiedzi zwracane są w formacie JSON.

Sukces (listy z paginacją):

json

{
  "data": [...],
  "total": 42,
  "limit": 50,
  "offset": 0
}

Sukces (pojedynczy zasób, opakowany w data):

json

{
  "data": {
    "id": "uuid",
    "title": "Mój tutorial",
    "created_at": "2026-03-28T12:00:00Z"
  }
}

Błąd:

json

{
  "error": "Document not found",
  "code": "NOT_FOUND"
}

Następne kroki

Uwierzytelnianie - Tworzenie kluczy API i zarządzanie scopami.
Dokumenty - CRUD na dokumentach - główny zasób platformy.
Webhooki - Powiadomienia w czasie rzeczywistym o zmianach.
Serwer MCP - Podłącz agenta AI przez Model Context Protocol.
Baza Wiedzy - Publikuj poradniki do firmowego centrum pomocy.