Разработчик
Добре дошли в API на GlobalSymbols
API на GlobalSymbols е REST API за достъп до данни на GlobalSymbols от уеб, мобилни и сървърни приложения. Създаден е да бъде последователен, предвидим и лесен за интегриране.
Известие за версията
Тази страница описва API v2 и ще остане справочна точка за бъдещите издания на API на GlobalSymbols.
Наследеният API v1 ще бъде прекратен в много близко бъдеще. Ако в момента използвате URL адреси /api/v1/..., трябва да актуализирате интеграцията си, за да използвате /api/v2/....
За повечето клиенти тази миграция трябва да е лесна: регистрирайте API ключ, ако е необходимо, и актуализирайте URL адресите на заявките към v2. Формата на отговорите е предвидена да остане същата, така че повечето интеграции не би трябвало да изискват промени в обработката на полезния товар.
Удостоверяване
Всички заявки изискват API ключ. Изпратете ключа си в един от тези заглавки:
Authorization: ApiKey <your_key>X-Api-Key: <your_key>
Нужен ви е API ключ?
Заявете ключ, ако използвате API за първи път, или заявете замяна, ако вече имате имейл адрес в нашите записи.
Ограничения на честотата
За справедливо използване и стабилност на платформата API е ограничен до 100 заявки в минута на клиент. Ако превишите този лимит, може да получите отговори за ограничение на честотата, затова интеграцията ви трябва да включва повторни опити или отлагане (backoff).
Ако ви е нужен по-висок лимит, моля, пишете на hello@globalsymbols.com.
Документация
Официалната API документация включва най-новите подробности за:
Налични крайни точки и базови URL адреси
Параметри на заявката и филтри
Схеми на отговорите и кодове на състоянието
Примерни заявки и отговори
Формати на изображения
Отговорите с изображения на символи включват полета image_url и native_format, за да може интеграцията ви да определи кой тип файл е наличен за всеки символ.
В момента API предоставя изображения на символи във формати PNG и SVG. PNG е най-сигурният формат, на който да разчитате при клиентски интеграции. SVG е наличен, когато основното хранилище публикува този символ като SVG.
Точният формат на изображението зависи от това, което публикува всяко хранилище. Използвайте полетата в отговора на API, за да откриете формата за всеки символ, вместо да приемате един формат за всички хранилища.
В рамките на платформата качванията на изображения се валидират и са ограничени до максимален размер на файла 800 KB.
Как се предоставят изображенията
Като цяло API предоставя изображения като URL адреси в полета на отговора като image_url. Това позволява на клиентите да изтеглят и кешират изображенията отделно от основния JSON отговор.
Изключение са полетата, ориентирани към преглед, които се вграждат вградено, а не се връщат като отделни URL адреси на ресурси.
Примерна заявка
Заменете базовия URL с този, посочен в официалната документация за вашата среда.
curl -H "X-Api-Key: <your_key>" \
-H "Accept: application/json" \
"https://your-api-base-url/api/v2/languages/active"Примерен отговор
[
{
"id": 1,
"name": "English",
"scope": "individual",
"category": "living",
"iso639_3": "eng"
}
]Първи стъпки
Заявете API ключ.
Прегледайте официалната документация за крайната точка, която искате да използвате.
Тествайте заявки с cURL, Postman или предпочитания от вас HTTP клиент.
Добавете повторни опити или отлагане (backoff) за отговори с ограничение на честотата.
Официалната документация е авторитетният източник за технически подробности и насоки за интеграция.