Dokumentacja API dla programistów

Połącz własną aplikację ze swoją przestrzenią roboczą: REST API, jego klucze i zakresy, błędy, limity żądań i webhooki.

Gdzie to znaleźć

⚙️ Ustawienia › Dokumentacja API · Strona główna › Zasoby › Dokumentacja API

Otwórz ten ekran
Dokumentacja API z menu bocznym, uwierzytelnianiem i punktami końcowymi.

Kroki

  1. Otwórz „Dokumentacja API” na pasku bocznym lub „Dokumentacja API” w menu „Zasoby” na stronie głównej.
  2. Zacznij od „Zacznij tutaj”: „Bazowy URL i konwencje”, „Uwierzytelnianie” i „Zakresy”.
  3. Wyszukaj „Punkty końcowe” według grupy; każdy pokazuje parametry, treść żądania, odpowiedź i błędy z przykładami.
  4. Przed uruchomieniem produkcyjnym przeczytaj „Błędy i kody stanu”, „Limity żądań” i „Webhooki (wychodzące)”. „OpenAPI JSON” pobiera całą specyfikację.

Rozwiązywanie problemów

Jak zdobyć klucz API?

Klucze są wydawane dla Twojej przestrzeni roboczej na prośbę; nie można ich jeszcze tworzyć w aplikacji. Klucze Twojej przestrzeni roboczej są wymienione na stronie dla programistów w obszarze AI, gdzie osoby zarządzające przestrzenią roboczą mogą też dodawać i testować punkty końcowe webhooków.

Wskazówki

  • Wywołuj API tylko ze swojego serwera. Nigdy nie umieszczaj klucza na stronie internetowej ani w aplikacji mobilnej.

Warto wiedzieć

  • Dokumentację API można czytać bez logowania.

Powiązane instrukcje

Zacznij za darmo Strona główna