Za programere
Dobro došli u GlobalSymbols API
GlobalSymbols API REST je API za pristup podacima GlobalSymbols iz web, mobilnih i poslužiteljskih aplikacija. Osmišljen je da bude dosljedan, predvidljiv i jednostavan za integraciju.
Obavijest o inačici
Ova stranica opisuje API v2 i ostat će referentna točka za buduća izdanja GlobalSymbols API-ja.
Naslijeđeni API v1 bit će ukinut u vrlo bliskoj budućnosti. Ako trenutačno koristite URL-ove /api/v1/..., trebali biste ažurirati integraciju da koristi /api/v2/....
Za većinu klijenata ta bi migracija trebala biti jednostavna: registrirajte API ključ ako je potrebno i ažurirajte URL-ove zahtjeva na v2. Oblici odgovora namijenjeni su ostati isti, pa većina integracija ne bi trebala zahtijevati izmjene obrade tereta.
Autentikacija
Svi zahtjevi zahtijevaju API ključ. Ključ pošaljite u jednom od ovih zaglavlja:
Authorization: ApiKey <your_key>X-Api-Key: <your_key>
Trebate API ključ?
Zatražite ključ ako API koristite prvi put ili zatražite zamjenu ako već imate e-adresu u evidenciji.
Ograničenja brzine
Radi pravednog korištenja i stabilnosti platforme API je ograničen na 100 zahtjeva u minuti po klijentu. Ako prekoračite to ograničenje, možete dobiti odgovore o ograničenju brzine, stoga bi vaša integracija trebala uključivati ponovni pokušaj ili backoff.
Ako trebate više ograničenje, pošaljite e-poštu na hello@globalsymbols.com.
Dokumentacija
Službena API dokumentacija uključuje najnovije pojedinosti o:
Dostupnim krajnjim točkama i osnovnim URL-ovima
Parametrima upita i filtrima
Shemama odgovora i statusnim kodovima
Primjerima zahtjeva i odgovora
Formati slika
Odgovori sa slikama simbola uključuju polja image_url i native_format kako bi vaša integracija mogla utvrditi koja je vrsta datoteke dostupna za svaki simbol.
API trenutačno izlaže slike simbola u formatima PNG i SVG. PNG je najsigurniji format na koji se možete osloniti za integracije klijenata. SVG je dostupan kada temeljni repozitorij taj simbol objavljuje kao SVG.
Točan format slike ovisi o tome što svaki repozitorij objavljuje. Koristite polja API odgovora da otkrijete format za svaki simbol umjesto da pretpostavljate jedan format u svim repozitorijima.
Unutar platforme prijenosi slika se provjeravaju i ograničeni su na najveću veličinu datoteke od 800 KB.
Kako se slike isporučuju
Općenito, API isporučuje slike kao URL-ove u poljima odgovora kao što je image_url. To klijentima omogućuje dohvaćanje i predmemoriranje slikovnih resursa odvojeno od glavnog JSON odgovora.
Iznimka su polja orijentirana na pregled, koja će biti ugrađena umjesto da se vraćaju kao zasebni URL-ovi resursa.
Primjer zahtjeva
Zamijenite osnovni URL onim navedenim u službenoj dokumentaciji za svoje okruženje.
curl -H "X-Api-Key: <your_key>" \
-H "Accept: application/json" \
"https://your-api-base-url/api/v2/languages/active"Primjer odgovora
[
{
"id": 1,
"name": "English",
"scope": "individual",
"category": "living",
"iso639_3": "eng"
}
]Kako započeti
Zatražite API ključ.
Pregledajte službenu dokumentaciju za krajnju točku koju želite koristiti.
Testirajte zahtjeve s cURL-om, Postmanom ili željenim HTTP klijentom.
Dodajte ponovni pokušaj ili backoff za odgovore s ograničenjem brzine.
Službena dokumentacija mjerodavan je izvor za tehničke pojedinosti i smjernice za integraciju.