Szybki start

Pięć kroków od zera do pierwszej faktury jako JSON. Potrzebujesz konta Ocost jako właściciel lub księgowy.

1. Zarejestruj się

Zarejestruj się na https://app.ocost.io/auth/sign-up albo się zaloguj. Pliki wysłane przez API pojawiają się w Pliki, jak każdy przesłany plik.

2. Utwórz klucz

  1. Otwórz Ustawienia › Programiści i wybierz Nowy klucz.
  2. Nazwij klucz od tego, kto go używa, na przykład „Odoo produkcja”.
  3. Zostaw zaznaczone uprawnienia i wybierz Utwórz klucz.
  4. Wybierz Kopiuj klucz. Klucz zaczyna się od ocost_sk_, a Ocost pokazuje go tylko raz.

Zachowaj go w powłoce na kolejne kroki:

Shell
export OCOST_KEY="ocost_sk_…"

3. Wyślij PDF

Wyślij plik jako multipart/form-data w polu file. external_ref to Twój własny identyfikator, a Ocost go zwraca.

curl -sS https://api.ocost.io/public/v1/files \
  -H "Authorization: Bearer $OCOST_KEY" \
  -F "file=@invoice.pdf" \
  -F "external_ref=account.move,42"

Ocost odpowiada 202 Accepted i zaczyna czytać:

JSON
{
  "id": "01a1b08c-6e3a-7562-8f4a-7924722667b1",
  "name": "invoice.pdf",
  "status": "received",
  "reason": null,
  "external_ref": "account.move,42",
  "documents": [],
  "sha256": "0edd5593…"
}

4. Poczekaj, aż zostanie odczytany

Pobieraj plik co kilka sekund, dopóki jego status to received lub reading. Większość plików PDF zajmuje mniej niż minutę.

curl -sS https://api.ocost.io/public/v1/files/$FILE_ID \
  -H "Authorization: Bearer $OCOST_KEY"

Odczytany plik wymienia swoje dokumenty:

JSON
{
  "id": "01a1b08c-6e3a-7562-8f4a-7924722667b1",
  "status": "read",
  "documents": [
    {
      "id": "01a1b08c-7aa1-7b52-9d4e-2f1f1c0c4f11",
      "kind": "invoice",
      "number": "RE-2026-1187",
      "pages": [1]
    }
  ]
}

Plik, który kończy jako not_read lub failed, podaje przyczynę w reason. Statusy i powody wymienia je wszystkie.

5. Odczytaj dokument

Pobierz pierwszy dokument pliku.

curl -sS https://api.ocost.io/public/v1/files/$FILE_ID/document \
  -H "Authorization: Bearer $OCOST_KEY"

Odpowiedź to faktura jako ocost.document.v1, tutaj skrócona:

JSON
{
  "schema": "ocost.document.v1",
  "kind": "invoice",
  "number": "RE-2026-1187",
  "issue_date": "2026-11-03",
  "due_date": "2026-12-03",
  "currency": "EUR",
  "seller": { "name": "Musterbüro Lieferant GmbH", "vat_id": "DE123456789" },
  "totals": { "net": 1068, "tax": 202.92, "gross": 1270.92 }
}

Dalej

Zobacz też