Docs/Rozpocznij/Wprowadzenie

Wprowadzenie

TwójProjekt to platforma API-first do zarządzania projektami i zadaniami. Ten przewodnik przeprowadzi Cię przez podstawową konfigurację i pierwsze wywołanie API.

💡

Wskazówka

Jeśli chcesz zacząć jak najszybciej, przejdź do Szybki start. To wprowadzenie wyjaśnia koncepcję i architekturę.

Instalacja

Zainstaluj bibliotekę kliencką za pomocą ulubionego menedżera pakietów:

bashKopiuj

# npm
npm install @twojprojekt/sdk

# yarn
yarn add @twojprojekt/sdk

# pnpm
pnpm add @twojprojekt/sdk

Uwierzytelnianie

Wszystkie żądania API wymagają klucza API. Klucz znajdziesz w ustawieniach swojego projektu.

typescriptKopiuj

import { Client } from '@twojprojekt/sdk'

const client = new Client({
  apiKey: process.env.TWOJPROJEKT_API_KEY,
  baseUrl: 'https://api.twojprojekt.pl/v1',
})

// Weryfikacja połączenia
const me = await client.users.me()
console.log('Połączono jako:', me.name)

⚠️

Ostrzeżenie bezpieczeństwa

Nigdy nie umieszczaj klucza API bezpośrednio w kodzie źródłowym. Zawsze używaj zmiennych środowiskowych lub menedżera sekretów.

API Reference: Użytkownicy

Kompletny przegląd endpointów do zarządzania użytkownikami.

GET/api/v1/usersZwraca listę wszystkich użytkowników

POST/api/v1/usersTworzy nowego użytkownika

GET/api/v1/users/:idZwraca szczegóły użytkownika

PATCH/api/v1/users/:idAktualizuje użytkownika

DELETE/api/v1/users/:idUsuwa użytkownika

Przykład odpowiedzi

Wszystkie odpowiedzi są w formacie JSON i zawierają standardową obwiednię.

200application/json

Kopiuj

{
  "data": {
    "id": "usr_abc123",
    "name": "Jan Kowalski",
    "email": "jan@example.com",
    "role": "admin",
    "createdAt": "2026-01-15T10:30:00Z"
  },
  "meta": {
    "requestId": "req_xyz789"
  }
}

Kody błędów

API używa standardowych kodów statusu HTTP.

Kod	Nazwa	Opis
`400`	Bad Request	Błędny format żądania
`401`	Unauthorized	Brak lub nieprawidłowy klucz API
`404`	Not Found	Zasób nie istnieje
`429`	Too Many Requests	Przekroczony limit żądań
`500`	Internal Error	Błąd po stronie serwera

Następny

Instalacja →