Projekty i dostarczanie – platforma deweloperska Flowtly

Korzystaj z kuratowanego wycinka schematu OpenAPI Flowtly, aby planować integracje, automatyzować procesy i synchronizować kluczowe dane.

Status dokumentacji

Ostatnia synchronizacja: 2024-07-08 12:00 (wersja aplikacji 2.0.0)

Publicznie udostępniamy tylko część encji. Po każdej aktualizacji Flowtly uruchom obie komendy synchronizacji, by odświeżyć dane.

Projekty i dostarczanie

Udostępniaj metadane projektów, członków i parametry rozliczeń.

Przegląd encji

Projekt

Wykorzystaj projekty Flowtly jako źródło prawdy dla PMO i finansów.

Endpointy

GET /api/projects

Lista projektów

Pobierz projekty z filtrami po kliencie, statusie i typie.

POST /api/projects

Utwórz projekt

Dodaj projekt z typem rozliczeń, klientem i harmonogramem.

GET /api/projects/{id}

Pobierz projekt po ID

Sprawdź szczegóły projektu, członków i walutę.

PATCH /api/projects/{id}

Zaktualizuj projekt

Zmień metadane, daty lub typ rozliczenia projektu.

GET /api/projects/preview

Preview projects

Preview project data before creation.

GET /api/projects/search

Search projects

Search projects by filters.

GET /api/projects/{id}/profitability

Get project profitability

Inspect profitability metrics for a project.

Przypadki użycia

Twórz projekty z CRM po wygranej szansie, aby przygotować obsadę.
Aktualizuj cykl życia projektu z zewnętrznych narzędzi, by prognozy Flowtly były precyzyjne.

Pola schematu

Project-project.read
Pole Typ Opis
id integer Identyfikator projektu w Flowtly.
client string | null IRI klienta powiązanego z projektem.
currency string | null Waluta projektu.
dateFrom string | null Planowana data startu.
dateTo string | null Planowana data zakończenia.
name string Nazwa projektu.
publicDescription string | null Opis widoczny dla klienta.
type string Model rozliczeń (fixed-price, T&M itp.).
clientHash string Zahashowany identyfikator klienta używany wewnętrznie.
notes string | null Notatki wewnętrzne.
color string Kolor wykorzystywany w interfejsie.
priceNet string | null Cena netto projektu (jeśli zdefiniowana).
taxGroup string | null IRI grupy podatkowej projektu.
projectMembers array Lista członków projektu (IRI).
status string Status cyklu życia projektu.
flattenType string Znormalizowany typ projektu w Flowtly.

Przykłady

POST /api/projects

Utwórz projekt Aurora Rollout

Dodaje projekt T&M powiązany z klientem CRM oraz planowanymi datami.

Ładunek żądania
{
    "name": "Aurora Rollout",
    "type": "time-and-material",
    "currency": "/api/currencies/EUR",
    "client": "/api/clients/cl_901",
    "dateFrom": "2024-06-01T00:00:00+00:00",
    "dateTo": "2024-12-31T00:00:00+00:00",
    "notes": "Expansion to Germany and France"
}
Ładunek odpowiedzi
{
    "@id": "/api/projects/prj_aurora",
    "@type": "Project",
    "id": 9821,
    "name": "Aurora Rollout",
    "type": "time-and-material",
    "currency": "/api/currencies/EUR",
    "client": "/api/clients/cl_901",
    "dateFrom": "2024-06-01T00:00:00+00:00",
    "dateTo": "2024-12-31T00:00:00+00:00",
    "status": "active"
}

Przegląd encji

Atrybut

Twórz i zarządzaj własnymi atrybutami, aby rozszerzać modele danych Flowtly.

Endpointy

GET /api/attributes

Lista atrybutów

Pobierz atrybuty z paginacją i filtrami.

POST /api/attributes

Utwórz atrybut

Zdefiniuj nowy atrybut ze slugiem, nazwą i typem.

GET /api/attributes/{id}

Pobierz atrybut po ID

Odczytaj konkretną definicję atrybutu.

PATCH /api/attributes/{id}

Zaktualizuj atrybut

Zmień nazwę lub opis atrybutu.

DELETE /api/attributes/{id}

Usuń atrybut

Usuń definicję atrybutu.

Pola schematu

Attribute-attribute.read
Pole Typ Opis
id integer Identyfikator atrybutu.
name string Nazwa wyświetlana atrybutu.
slug string Slug używany do referencji atrybutu.
type string Typ danych atrybutu.
description string | null Opcjonalny opis przeznaczenia atrybutu.
Whatsapp