Преглед за разработчици

Страницата за разработчици предоставя достъп до API документацията на Shifton и инструменти за разработчици за изграждане на персонализирани интеграции.

Какво представлява това?

Страницата за разработчици е отправна точка за технически интеграции с Shifton. Тя съдържа три раздела: Преглед, Webhooks и Приложения. Разделът Преглед предоставя бързи връзки към текущата и остарялата API документация, които можете да използвате за изграждане на персонализирани интеграции, автоматизиране на работни процеси или свързване на Shifton с вашите вътрешни инструменти.

Предварителни изисквания

Изискване	Подробности
Роля	Owner
Знания	Основно разбиране на API и уеб разработка (или достъп до разработчик, който ги притежава)

Стъпка по стъпка

Достъп до страницата за разработчици

В лявата лента за навигация кликнете Интеграции.

Навигирайте до страницата за разработчици.

Ще видите три раздела в горната част: Преглед, Уебхукове и Приложения.

Използване на раздела Преглед

Разделът Преглед показва връзки към API документацията на Shifton:

Връзка	Описание
Нова документация	Връзка към текущата, актуална API документация
Стара документация	Връзка към остарялата API документация за по-стари интеграции

Кликнете Нова документация, за да отворите текущата API справка в нов раздел.

Ако имате съществуваща интеграция, изградена на по-старото API, кликнете Стара документация, за да получите достъп до остарялата справка.

Навигация към другите раздели за разработчици

От страницата за разработчици можете също да получите достъп до:

Раздел Уебхукове — Настройте крайни точки на webhook, за да получавате известия за събития в реално време от Shifton.

Раздел Приложения — Създавайте и управлявайте персонализирани приложения, интегрирани с Shifton.

Те са описани подробно в отделни статии.

Права за достъп

Роля	Преглед на страницата за разработчици	Достъп до API документация	Създаване на Webhooks/Приложения
Owner	Да	Да	Да
	Да	Да	Да
Manager	Не	Не	Не
Служител	Не	Не	Не

Често задавани въпроси

В: Необходими ли са ми умения за програмиране, за да използвам страницата за разработчици?
О: API документацията е предназначена за разработчици. Ако сте нетехнически мениджър, можете да споделите връзките към документацията с вашия екип за разработка или IT отдел.

В: Коя API документация да използвам — нова или стара?
О: Използвайте Нова документация за всички нови интеграции. Старата документация е предоставена за обратна съвместимост със съществуващи интеграции, изградени на остарялото API.

В: Има ли ограничение за броя заявки към API?
О: Да, може да се прилагат ограничения за заявките към API. Вижте API документацията за конкретни подробности относно ограниченията на заявките и най-добрите практики.

В: Мога ли да тествам API извиквания, без да засягам реалните данни?
О: Вижте API документацията за информация относно тестови среди или режими на sandbox, ако са налични.

Възможни проблеми и решения

Проблем	Възможна причина	Решение
Страницата за разработчици не е видима в лентата за навигация	Нямате роля Owner	Помолете Owner на акаунта да ви предостави подходящата роля
Връзката към документацията води до страница с грешка	Временен проблем с услугата	Опитайте по-късно или се свържете с поддръжката на Shifton
Не сте сигурни коя версия на API да използвате	Работите със съществуваща интеграция	Проверете текущия код на интеграцията за URL адреси на API крайни точки, за да определите коя версия използва
API ключът не е видим	Ключът може да трябва да бъде генериран първо	Следвайте инструкциите в API документацията, за да генерирате API ключ