Connexion à des API anonymes

Lorsque vous créez des solutions SharePoint Framework, vous pouvez consommer des API publiques, comme des informations boursières ou météorologiques. Cet article décrit comment se connecter à des API publiques dans des solutions SharePoint Framework.

Notes

Dans cet article, les API publiques et anonymes sont utilisées indifféremment. Cet article décrit comment se connecter à des API qui ne nécessitent aucune authentification ou qui sont sécurisées avec une clé de fonction/d’API pouvant être transmise via des paramètres de chaîne de requête. Consultez les autres pages de cette section de la documentation pour plus d’informations sur la connexion aux API SharePoint ou aux API sécurisées avec Azure AD.

Connexion à des API anonymes à l’aide de la classe HttpClient

Le plus simple pour se connecter à des API anonymes dans vos solutions SharePoint Framework consiste à utiliser la classe HttpClient fournie dans le cadre de SharePoint Framework. Par exemple, pour obtenir des informations factices du service Typicode, exécutez :

this.context.httpClient
  .get('https://jsonplaceholder.typicode.com/todos/1', HttpClient.configurations.v1)
  .then((res: HttpClientResponse): Promise<any> => {
    return res.json();
  })
  .then((response: any): void => {
    console.log(response);
  });

Comme avec la classe SPHttpClient que vous utilisez pour vous connecter aux API SharePoint, la classe HttpClient offre des fonctionnalités similaires permettant d’exécuter des demandes web courantes. Si nécessaire, vous pouvez utiliser ses options pour configurer des demandes.

Par exemple, pour spécifier des en-têtes de demande, utilisez le code suivant :

this.context.httpClient
  .get('https://jsonplaceholder.typicode.com/todos/1', HttpClient.configurations.v1,
    {
      headers: [
        ['accept', 'application/json']
      ]
    })
  .then((res: HttpClientResponse): Promise<any> => {
    return res.json();
  })
  .then((response: any): void => {
    console.log(response);
  });

Considérations relatives à la classe HttpClient

Lorsque vous utilisez la classe HttpClient, prenez en compte les points suivants.

Les cookies d’authentification ne sont pas inclus

La classe HttpClient est très semblable à la classe SPHttpClient, mais elle n’inclut pas les cookies d’authentification dans ses demandes. Par conséquent, si vous l’utilisez pour vous connecter aux API SharePoint, vos demandes échouent avec une réponse 401 Non autorisé.

Élément de SharePoint Framework

La classe HttpClient fait partie de SharePoint Framework et vous n’avez pas besoin de dépendances supplémentaires pour commencer à l’utiliser. Elle est déjà disponible sur la page et, par conséquent, son utilisation n’entraîne pas de dégradation des performances supplémentaire à l’exécution.