Это обзор интерфейса прикладного программирования Waytobi (Rest API). В этой документации описаны использование, ограничения и политика API.
Мы сохраняем за собой право вносить изменения в API без предварительного оповещения. Критические изменения, например, удаление или переименование свойств объекта могут производиться в существующей версии API с уведомлением за две недели, и любое прекращение поддержки будет задокументировано в соответствующих разделах. Критические структурные изменения будут производиться только в рамках обновления версии.
Этот API поддерживает только SSL и доступен только по https://app.waytobi.com/api/. Под авторизацией имеется ввиду базовая аутентификация с вашим API токеном аккаунта. Этот токен находится в вашем аккаунте Waytobi в разделе Настройки | API разработчика. Доступ к API отключен по умолчанию и должен быть включен перед подключением к API.
При необходимости вы можете сами создать и отослать заголовки базовой аутентификации.
Предоставьте заголовок авторизации с контентом Basic, после чего следует токен строка. Например: Basic XZZRtaW46YARtaF8=
curl -H "Authorization: Basic XZZRtaW46YARtaF8=" -H "Content-Type: application/json" https://app.waytobi.com/api/users
Этот API принимает и возвращает данные в формате JSON или XML. Чтобы сообщить API с каким типом контента вы хотите работать, вы должны предоставить заголовок Content-Type: application/json или Content-Type: application/xml для всех запросов GET, PUT, POST и DELETE. Возможно, вы также захотите установить заголовок Accept: application/json или Accept: application/xml на свои запросы, но он будет переопределен заголовком Content-Type.
ПРИМЕЧАНИЕ: При использовании cUrl на Windows, вам нужно будет взять данные в скобки " и экранировать следующим образом:
curl https://app.waytobi.com/api/kpientries
-H "Content-Type: application/json"
-d "{\"user_id\": 111, \"kpi_id\": 222, \"entry_date\": \"2020-01-15\", \"actual\": 100, \"target\": 150, \"notes\": \"This is a note\"}"
-v -u {token} -X POST
Если Waytobi не может обработать ваш запрос, появится ошибка 5хх. 500 подразумевает, что приложение столкнулось с непредвиденной проблемой или оно не работает. Когда такое происходит, система уведомляет нашу команду службы поддержки. Вам следует повторить запрос позже или связаться с командой службы поддержки Waytobi тут support@waytobi.com.
Если вы используете .NET, тогда исключение типа System.Net.WebException будет выдаваться для всех http ошибок 4xx и 5xx.
Этот API ограничен в частоте обращений и позволяет совершить только ограниченное количество запросов в минуту. Мы сохраняем за собой право изменять ограничение частоты обращений для конечных пользователей, чтобы предоставлять первоклассный сервис для каждого клиента. Пользователи нашего API могут рассчитывать на минимум 200 запросов в минуту.
В случае превышения ограничения частоты обращений, вы получите ответ в виде кода ответа HTTP 403 Forbidden и тела документа, в котором уточняется, почему срабатывает ограничитель частоты. Далее, в ответе будет содержаться заголовок Retry-After, указывающий на количество времени, которое вам нужно будет подождать прежде чем вы сможете сделать следующий запрос. Вы должны предусмотреть это в своем клиенте API для того, чтобы все работало бесперебойно.
В дополнение к заголовкам ограничения скорости по умолчанию вы также увидите:
X-RateLimit-LimitX-RateLimit-RequestsX-RateLimit-DurationМы хотим сделать наши API такими же чистыми и простыми как наш интерфейс. Одна из составляющих популярности Waytobi это то, что мы прислушиваемся к нашим пользователям и учитываем их обратную связь в будущих версиях. Поэтому, обращайтесь к нам по адресу support@waytobi.com и поделитесь с нами своим опытом, разочарованиями, предложениями и идеями, а мы приложим все усилия, чтобы внедрить эти улучшения.
Ищете что-то конкретное? Попробуйте посмотреть различные папки и категории соответсвующие вашему запросу на предмет необходимой информации.
Связаться с нами