insee_endpoint: Get Insee endpoints

In InseeFrLab/apinsee: Manage Access to Insee APIs

Get Insee endpoints

Description

Cette fonction renvoie les points d'accès définis par api.insee.fr.

Usage

insee_endpoint(insee_url = getOption("apinsee.url"))

Arguments

insee_url

Adresse du site fournissant les API. Ce paramètre n'est utile que pour un usage interne à l'Insee, voir la section "Utilisation interne à l'Insee".

Value

Un objet de classe oauth_endpoint.

Utilisation interne à l'Insee

Dans le cas d'utilisation standard, la valeur de l'option apinsee.url est "https://api.insee.fr/". Il n'est pas utile de la modifier sauf pour les agents de l'Insee qui souhaiteraient utiliser les plateformes de test, de recette ou de pré-production. Dans ce cas, afin de rendre les programmes portables d'un environnement à un autre.il est préférable de déclarer l'adresse en modifiant l'option apinsee.url : options(apinsee.url = "<URL>").

Examples

# Modify the following option to access to a different url
# options(apinsee.url = "https://api.insee.fr/")

library(apinsee)
insee_endpoint()

InseeFrLab/apinsee documentation built on July 31, 2023, 4:32 a.m.