Développeur

Bienvenue dans l’API GlobalSymbols

L’API GlobalSymbols est une API REST permettant d’accéder aux données GlobalSymbols depuis des applications web, mobiles et serveur. Elle est conçue pour être cohérente, prévisible et facile à intégrer.

Avis de version

Cette page décrit l’API v2 et restera le point de référence pour les prochaines versions de l’API GlobalSymbols.

L’ancienne API v1 sera bientôt arrêtée. Si vous utilisez actuellement des URL /api/v1/..., vous devez mettre à jour votre intégration pour utiliser /api/v2/....

Pour la plupart des clients, cette migration devrait être simple : enregistrez une clé API si besoin et mettez à jour vos URL de requête vers v2. La forme des réponses est destinée à rester la même, de sorte que la plupart des intégrations n’auront pas à modifier le traitement des payloads.

Authentification

Toutes les requêtes nécessitent une clé API. Envoyez votre clé dans l’un de ces en-têtes :

• Authorization: ApiKey <your_key>

• X-Api-Key: <your_key>

Besoin d’une clé API ?

Demandez une clé si vous utilisez l’API pour la première fois, ou demandez un remplacement si une adresse e-mail est déjà enregistrée.

Limites de débit

Pour un usage équitable et la stabilité de la plateforme, l’API est limitée à 100 requêtes par minute et par client. Si vous dépassez cette limite, vous pouvez recevoir des réponses de limitation ; votre intégration doit donc prévoir une gestion des tentatives (retry) ou un backoff.

Si vous avez besoin d’une limite plus élevée, veuillez écrire à hello@globalsymbols.com.

Documentation

La documentation officielle de l’API contient les informations les plus récentes sur :

• Les points de terminaison disponibles et les URL de base

• Les paramètres de requête et les filtres

• Les schémas de réponse et les codes de statut

• Des exemples de requêtes et de réponses

Formats d’image

Les réponses d’images de symboles incluent un champ image_url et un champ native_format afin que votre intégration puisse déterminer le type de fichier disponible pour chaque symbole.

L’API expose actuellement les images de symboles aux formats PNG et SVG. Le PNG est le format le plus sûr pour les intégrations clientes. Le SVG est disponible lorsque le dépôt sous-jacent publie ce symbole en SVG.

Le format d’image exact dépend de ce que publie chaque dépôt. Utilisez les champs de la réponse API pour découvrir le format de chaque symbole, plutôt que de supposer un format unique pour tous les dépôts.

Sur la plateforme, les téléversements d’images sont validés et limités à une taille maximale de 800 Ko.

Comment les images sont fournies

En général, l’API fournit les images sous forme d’URL dans des champs de réponse tels que image_url. Cela permet aux clients de récupérer et de mettre en cache les images séparément de la réponse JSON principale.

L’exception concerne les champs orientés aperçu, qui sont intégrés en ligne plutôt que renvoyés comme URL d’actifs distinctes.

Exemple de requête

Remplacez l’URL de base par celle indiquée dans la documentation officielle pour votre environnement.

curl -H "X-Api-Key: <your_key>" \
 -H "Accept: application/json" \
 "https://your-api-base-url/api/v2/languages/active"

Exemple de réponse

[
 {
 "id": 1,
 "name": "English",
 "scope": "individual",
 "category": "living",
 "iso639_3": "eng"
 }
]

Pour commencer

1. Demandez une clé API.

2. Consultez la documentation officielle du point de terminaison que vous souhaitez utiliser.

3. Testez les requêtes avec cURL, Postman ou votre client HTTP préféré.

4. Ajoutez une gestion retry ou backoff pour les réponses limitées en débit.

La documentation officielle est la source faisant autorité pour les détails techniques et les conseils d’intégration.