Hype Exchange Service API

Вижте Интеграция от настройката до пускането в работа за двата типа интеграции, стъпките на синхронизация и задължителното ръчно съпоставяне след активиране на custom интеграция.

Hype API следва REST принципите и използва стандартни HTTP методи.

Първи стъпки

За да използвате Hype API:

Създайте интеграция между вашата платформа и клиент на Hype, за да получите API ключ.
Спазвайте ограниченията на броя заявки.
Използвайте HTTPS. HTTP заявките се пренасочват към съответния HTTPS ресурс със статус 301.
При грешки в удостоверяването, маршрутизирането, ограничението на заявките и неочаквани сървърни грешки Hype API връща съответния HTTP статус и JSON тяло като следното:

json

{
  "error": 1,
  "message": "Error description text"
}

Удостоверяване

Hype API удостоверява заявките чрез Bearer токен в хедъра Authorization. Свържете се с поддръжката на Hype, за да създадете интеграция между вашата платформа и съществуващ клиент на Hype и да получите токен.

Отговор при грешка в удостоверяването

Липсващ или невалиден токен води до 401 Unauthorized.

Някои адреси използват различно тяло на грешката. Адресите за справки връщат грешките 403 и 404 като {"message": "..."}, а грешките при валидация 422 добавят обект errors с невалидните полета. Вижте отговорите при грешка на всяка страница.

Адреси на средите

Разработка: https://es.dev.hype-software.com

Продукция: https://es.hype-software.com

Ограничения на броя заявки

Ограниченията са за всеки API токен и зависят от групата адреси:

Адреси	Ограничение
`/tasks/` и `/webhook/`	1000 заявки в минута
`/api/*`, включително заявяване и проверка на справки (`pollUrl`), интеграции и задания в опашката	60 заявки в минута

При надвишаване на ограничението API връща 429 Too Many Requests.

Отговорите в рамките на ограничението съдържат тези хедъри:

Хедър	Описание
`X-RateLimit-Limit`	Максимален брой разрешени заявки в минута.
`X-RateLimit-Remaining`	Оставащи заявки в текущия времеви прозорец.

Отговорът 429 не съдържа Retry-After или X-RateLimit-Reset. Изчакайте преди нов опит; прозорецът е една минута.

Hype Exchange Service API ​

Първи стъпки ​

Удостоверяване ​

Отговор при грешка в удостоверяването ​

Адреси на средите ​