Przejdź do treści

Wprowadzenie do API

Czym jest API BakePilot, kto może z niego korzystać i jakie ma limity.

Ostatnia aktualizacja:

Czym jest API?

API (Application Programming Interface) pozwala łączyć BakePilot z innymi systemami programistycznie. Jeśli masz własną stronę z formularzem zamówień lub sklep internetowy, możesz przesyłać dane do BakePilot automatycznie. Przykład: formularz na stronie, który po wysłaniu od razu zakłada zamówienie i klienta w BakePilot.

  • REST API z odpowiedziami JSON
  • Tworzenie i odczyt zamówień oraz klientów
  • Odczyt katalogu produktów
  • Interaktywna dokumentacja (Swagger) pod https://app.bakepilot.pl/api/v1/docs

Otwórz interaktywną dokumentację API (Swagger) (otwiera się w nowej karcie)

Interaktywna dokumentacja BakePilot Public API (Swagger) z sekcjami Customers, Orders i Products oraz przyciskiem Authorize
Swagger pokazuje wszystkie endpointy pogrupowane w zakładki (klienci, zamówienia, produkty, receptury, składniki, WZ, oferty, umowy): klienci, zamówienia (odczyt i tworzenie) oraz katalog produktów.

Dla kogo jest API?

API jest przeznaczone dla programistów i firm integratorskich. Jeśli nie jesteś programistą, nie musisz z niego korzystać - wszystkie funkcje BakePilot są dostępne przez panel. API to opcja dla cukierni, które chcą podpiąć własną stronę, sklep albo automatyzację.

  • Agencje IT budujące integracje dla cukierni
  • Programiści integrujący BakePilot z innymi systemami
  • Firmy z własnymi stronami i sklepami internetowymi
  • Automatyzacje (np. Zapier, Make) wywołujące zapytania HTTP

Limity i dostępność

Klucze API generuje Administrator organizacji w Ustawieniach, w sekcji „Klucze API”. Sekcja jest aktywna od planu Profesjonalnego (w okresie próbnym również) - w planie Podstawowym pokazuje komunikat „Publiczne API i klucze API są dostępne od planu Profesjonalnego”. Każdy klucz ma limit 120 zapytań na minutę; po jego przekroczeniu API odpowiada kodem 429.

  • Klucz generujesz w Ustawieniach, sekcja „Klucze API” (Administrator)
  • Dostępne od planu Profesjonalnego i w okresie próbnym
  • Klucz zaczyna się od „bp_live_” i jest pokazywany tylko raz
  • 120 zapytań na minutę na klucz, powyżej - błąd 429
  • Większe limity - napisz do nas przez czat pomocy

Powiązane artykuły