Dokumentacja dla programistów
Publiczne API Requiply pozwala Twojej stronie internetowej, aplikacji lub narzędziu wewnętrznemu odczytywać katalog, sprawdzać dostępność, wyceniać, przyjmować zapytania o rezerwację oraz pracować z rezerwacjami, klientami, sprzedażą i raportami.
Sposoby integracji
| Opcja | Do czego najlepiej się nadaje |
|---|---|
SDK TypeScript (@requiply/api-sdk) | Aplikacje JavaScript i TypeScript: Next.js, Nuxt, Node.js, funkcje serverless i przeglądarki. Typowane dane wejściowe i odpowiedzi, serializacja zapytań i RequiplyError. |
| REST API | Każdy inny język lub środowisko uruchomieniowe. JSON przez HTTPS pod adresem https://api.requiply.com/api/public/v1. |
| Serwer MCP | Agenci AI, którzy mają pracować z danymi organizacji przez narzędzia zamiast wywołań HTTP. |
W JavaScript zalecaną drogą jest SDK. Te przewodniki dotyczą SDK w wersji 0.2.0, która obsługuje Node.js 18 lub nowszy oraz nowoczesne przeglądarki z fetch. Osobne pakiety @requiply/next i @requiply/nuxt są planowane, ale jeszcze niedostępne.
Od czego zacząć
- Utwórz klucz API i wybierz klucz publiczny lub tajny.
- Zainstaluj SDK.
- Przejdź przez Szybki start, aby wykonać pierwsze wywołanie z serwera i wysłać zapytanie o rezerwację ze sklepu.
- Sprawdzaj poszczególne metody w przewodnikach po zasobach SDK, a punkty końcowe w dokumentacji REST API.
- Skopiuj gotowy wzorzec z Przykładów.
Co może sklep z kluczem publicznym
- Pokazać nazwę organizacji, logo, godziny pracy, opcje dostawy i metody płatności.
- Wyświetlić kategorie, pozycje i usługi z dostępnością w wybranych datach.
- Obliczyć dokładną wycenę z uwzględnieniem progów cenowych i usług.
- Wysłać zapytanie o rezerwację, które pracownicy zatwierdzają w aplikacji.
- Zaoferować towary na sprzedaż razem z rezerwacją, gdy organizacja sprzedaje klientom.
Wszystko inne, w tym klienci, rezerwacje, sprzedaż i raporty, wymaga klucza tajnego na serwerze.
Linki do pakietu
Zużycie AI
Sprawdzaj, ile kredytów AI obejmuje Twój plan, ile już wykorzystano, i dokupuj kredyty dla asystenta, tworzenia szablonów, zdjęć zestawów, widżetu na stronę i czatu w portalu.
Wygeneruj token API
Administratorzy tworzą tokeny API, nazywane kluczami API, w Ustawienia → Organizacja → Klucze API: klucz tajny dla serwerów lub klucz publiczny dla stron internetowych.