lubWypróbuj bezpłatnie
Zaloguj się Zacznij za darmo

Przegląd API

Adres bazowy, format odpowiedzi, identyfikatory i pierwsze zapytanie do REST API Hypris.

Na tej stronie

REST API daje dostęp do tych samych danych co aplikacja: workspace, baz, rekordów, dokumentów, rozmów i automatyzacji. Każde zapytanie działa w uprawnieniach konta albo aplikacji, która je wysyła, więc API nigdy nie pokaże więcej niż interfejs.

Adres bazowy

Adres bazowy
https://api.staging.hypris.com/v1

Ścieżki w tej dokumentacji są względne do adresu bazowego. GET /me oznacza więc GET https://api.staging.hypris.com/v1/me. Treść zapytań i odpowiedzi to JSON, więc wysyłaj nagłówek Content-Type: application/json.

Pierwsze zapytanie

Utwórz klucz API w ustawieniach konta i pobierz listę swoich workspace:

curl "https://api.staging.hypris.com/v1/me/workspaces" \
  -u "$KEY_ID:$SECRET"

Format odpowiedzi

Każda udana odpowiedź ma tę samą kopertę. Właściwe dane są zawsze w polu data:

200 OK
{
  "success": true,
  "data": {
    "workspaces": [],
    "hasMore": false
  }
}

Błąd ma success: false i opis w polu error. Nazwy błędów i kody HTTP opisuje przewodnik Błędy i limity.

Identyfikatory

Identyfikatory workspace, baz, pól, rekordów i innych zasobów to 24-znakowe ciągi szesnastkowe, na przykład 65a1f0c2b3d4e5f601234567. Podajesz je w ścieżce, na przykład /database/:databaseId.

Daty

Znaczniki czasu w odpowiedziach, takie jak createdAt, są w formacie ISO 8601. Wartości pól typu data mają własny, jawny kształt z datą i godziną, opisany w przewodniku Wartości pól.

Operacje w tle

Część operacji, na przykład aktualizacja wartości rekordu albo tworzenie wielu rekordów naraz, kończy się w tle. Odpowiedź zawiera wtedy jobId, a wynik sprawdzisz tak:

GET/job/:jobId
200 OK
{
  "success": true,
  "data": {
    "job": {
      "jobType": "…",
      "status": "completed",
      "progress": null,
      "completedAt": "2026-10-02T08:00:00.000Z",
      "failedAt": null,
      "failedReason": null,
      "output": null
    }
  }
}

Pole status przyjmuje wartości running, completed albo failed. Gdy zadanie się nie powiedzie, przyczynę znajdziesz w failedReason. Zadanie odczyta tylko ten, kto je utworzył. Dla innych odpowiedź to 404.

Co dalej