API Developer

L'API Developer permet d'accéder aux métadonnées de toutes les familles desservies par Google Fonts. Elle permet aux applications d'interroger Google Fonts pour les familles de polices disponibles. L'API REST fournit des données au format JSON qui incluent les styles et les scripts (appelés sous-ensembles dans Google Fonts) dans chaque famille. L'API peut trier la liste des familles par ordre alphabétique, par date d'ajout, par nombre de styles, par tendance ou par popularité.

Audience

Ce document est destiné aux développeurs Web et d'applications. Pour utiliser l'API Developer, vous devez connaître JavaScript.

Un bref exemple

Pour récupérer la liste dynamique des polices proposées par le service Google Fonts, envoyez la requête suivante:

https://www.googleapis.com/webfonts/v1/webfonts?key=YOUR-API-KEY

Exemple de résultat :

{
 "kind": "webfonts#webfontList",
 "items": [
  [...]
  {
    "family": "Anonymous Pro",
    "variants": [
      "regular",
      "italic",
      "700",
      "700italic"
    ],
    "subsets": [
      "cyrillic",
      "greek",
      "latin",
      "latin-ext"
    ],
    "version": "v21",
    "lastModified": "2022-09-22",
    "files": {
      "regular": "http://fonts.gstatic.com/s/anonymouspro/v21/rP2Bp2a15UIB7Un-bOeISG3pLlw89CH98Ko.ttf",
      "italic": "http://fonts.gstatic.com/s/anonymouspro/v21/rP2fp2a15UIB7Un-bOeISG3pHl428AP44Kqr2Q.ttf",
      "700": "http://fonts.gstatic.com/s/anonymouspro/v21/rP2cp2a15UIB7Un-bOeISG3pFuAT0CnW7KOywKo.ttf",
      "700italic": "http://fonts.gstatic.com/s/anonymouspro/v21/rP2ap2a15UIB7Un-bOeISG3pHl4OTCzc6IG30KqB9Q.ttf"
    },
    "category": "monospace",
    "kind": "webfonts#webfont",
    "menu": "http://fonts.gstatic.com/s/anonymouspro/v21/rP2Bp2a15UIB7Un-bOeISG3pHl028A.ttf"
  },
  {
    "family": "Antic",
    "variants": [
      "regular"
    ],
    "subsets": [
      "latin"
    ],
    "version": "v19",
    "lastModified": "2022-09-22",
    "files": {
      "regular": "http://fonts.gstatic.com/s/antic/v19/TuGfUVB8XY5DRaZLodgzydtk.ttf"
    },
    "category": "sans-serif",
    "kind": "webfonts#webfont",
    "menu": "http://fonts.gstatic.com/s/antic/v19/TuGfUVB8XY5DRZZKq9w.ttf"
  },
  [...]
 ]
}

Identifier votre application auprès de Google

Votre application doit s'identifier chaque fois qu'elle envoie une requête à l'API Google Fonts Developer, en incluant une clé API dans chaque requête.

Obtenir et utiliser une clé API

Obtenir une clé

Vous pouvez également en créer un sur la page Identifiants.

Une fois la clé API obtenue, votre application peut ajouter le paramètre de requête key=yourAPIKey à toutes les URL de requête.

La clé API peut s'intégrer aux URL en toute sécurité et ne nécessite pas d'encodage.

Détails

La réponse JSON (voir l'exemple ci-dessus) est composée d'un tableau nommé "items", qui contient des objets contenant des informations sur chaque famille de polices.

Un objet familial se compose des champs suivants:

  • kind: genre d'objet, objet webfont
  • family: Nom de la famille
  • Sous-ensembles: liste des scripts compatibles avec la famille.
  • menu: URL du sous-ensemble familial couvrant uniquement le nom de la famille.
  • variantes: les différents styles disponibles pour la famille
  • version: version de la famille de polices.
  • Axes: plage d'axes, uniquement présente sur demande(voir ci-dessous) pour les polices variables.
  • lastModified: date (format "aaaa-MM-jj") de la dernière modification de la famille de polices.
  • files: les fichiers de famille de polices (avec tous les scripts compatibles) pour chacune des variantes disponibles.

En combinant les informations de chaque famille, vous pouvez facilement créer une requête API Fonts. Par exemple, en supposant que nous faisons référence à l'objet familial pour l'API Pro anonyme:

[...]

var apiUrl = [];
apiUrl.push('https://fonts.googleapis.com/css?family=');
apiUrl.push(anonymousPro.family.replace(/ /g, '+'));
if (contains('italic', anonymousPro.variants)) {
  apiUrl.push(':');
  apiUrl.push('italic');
}
if (contains('greek', anonymousPro.subsets)) {
  apiUrl.push('&subset=');
  apiUrl.push('greek');
}

// url: 'https://fonts.googleapis.com/css?family=Anonymous+Pro:italic&subset=greek'
var url = apiUrl.join('');

[...]

Tri

Par défaut, la liste des familles est affichée sans ordre particulier. Il est toutefois possible de trier la liste à l'aide du paramètre de tri:

https://www.googleapis.com/webfonts/v1/webfonts?sort=popularity

Les valeurs de tri possibles sont les suivantes:

  • alpha: trier la liste par ordre alphabétique
  • date: trier la liste par date d'ajout (police la plus récente ajoutée ou mise à jour en premier)
  • popularité: triez la liste par popularité (famille la plus populaire en premier)
  • style: trie la liste par nombre de styles disponibles (famille ayant le plus de styles en premier)
  • tendances: triez la liste en fonction des familles qui constatent une augmentation de l'utilisation (la famille dont les chiffres de croissance sont les plus élevés en premier).

Filtrage

Interroger une famille spécifique

https://www.googleapis.com/webfonts/v1/webfonts?family=family_name

Toutes les familles acceptant le sous-ensemble grec

https://www.googleapis.com/webfonts/v1/webfonts?subset=subset_name

Optimisation

Pour récupérer les fichiers de polices compressées au format woff2

https://www.googleapis.com/webfonts/v1/webfonts?capability=WOFF2

Polices variables

Les polices variables offrent des plages de styles continus. Par défaut, une combinaison de fichiers de polices statiques est renvoyée pour les polices variables instanciées aux positions standards. Si capaibility=VF est défini, le fichier de police variable est renvoyé à la place des fichiers statiques, avec les métadonnées de la plage d'axes disponibles:

https://www.googleapis.com/webfonts/v1/webfonts?capaibility=VF

Exemple de réponse :

{
 "kind": "webfonts#webfontList",
 "items": [
  [...]
  {
    "family": "Noto Sans Display",
    "variants": [
      "regular",
      "italic"
    ],
    "subsets": [
      "cyrillic",
      "cyrillic-ext",
      "greek",
      "greek-ext",
      "latin",
      "latin-ext",
      "vietnamese"
    ],
    "version": "v20",
    "lastModified": "2022-09-22",
    "files": {
      "regular": "http://fonts.gstatic.com/s/notosansdisplay/v20/RLplK4fy6r6tOBEJg0IAKzqdFZVZxokvfn_BDLxR.ttf",
      "italic": "http://fonts.gstatic.com/s/notosansdisplay/v20/RLpjK4fy6r6tOBEJg0IAKzqdFZVZxrktdHvjCaxRgew.ttf"
    },
    "category": "sans-serif",
    "kind": "webfonts#webfont",
    "menu": "http://fonts.gstatic.com/s/notosansdisplay/v20/RLpbK4fy6r6tOBEJg0IAKzqdFZVZxpMkXJMhnB9XjO1o90LuV-PT4Doq_AKp_3cKZTCa3g.ttf",
    "axes": [
      {
        "tag": "wdth",
        "start": 62.5,
        "end": 100
      },
      {
        "tag": "wght",
        "start": 100,
        "end": 900
      }
    ]
  },
  [...]
 ]
}

Spécification de l'URL de l'API

webfonts?key=<your_key>[&family=<family>][&subset=<subset>][&capability=<capability>...][&sort=<sort>]

your_key: votre clé API pour développeur.

family: nom d'une famille de polices.

subset: nom d'un sous-ensemble de polices.

capability: VF | WOFF2.

sort: alpha | date | popularity | style | trending