web-services / address-kit /
@Nicolas Thouvenin Nicolas Thouvenin authored on 21 Nov 2023
..
v1 docs(address-kit): Add examples metadata to affilcountry.ini 1 year ago
README.md docs(address-kit): Use a lodex-workers-python@4.0.11 1 year ago
config.json root cleaning 1 year ago
examples.http docs(address-kit): Use the right domain name 1 year ago
requirements.txt build(address-kit): Put requirements versions 1 year ago
swagger.json openapi 3.1.0 allow info.summary 1 year ago
tests.hurl test(address-kit): Add tests.hurl 1 year ago
README.md

address-kit

Cette instance propose des outils de traitement d'adresses

Configuration

Voir le fichier de configuration.

⚠ L'application à utiliser doit être un worker avec python version 3.9.
À l'heure de l'écriture de cette documentation, c'est inistcnrs/lodex-workers-python@4.0.11 qui est le plus adapté.

Utilisation

  • [V1/cnrsunit/cnrsunit]

V1/cnrsunit/cnrsunit

Ce service permet à partir d'une adresse comportant un code unité CNRS d'avoir le nom du laboratoire, son sigle, son rnsr, sa tutelle cnrs

Prend en entrée du JSON avec deux champs: id et value, et renvoie un JSON avec le code langue dans le champ value.

Paramètres de v1/cnrsunit/cnrsunit

nom description
indent true ou false, indente le JSON résultat ou non (true par défaut)

Exemple

cat <<EOF | curl -X POST --data-binary @- "https://address-kit.services.inist.fr/v1/cnrsunit/cnrsunit"

[{"id":1, "value":"université sciences et technologies bordeaux 1 institut national de physique nucléaire et de physique des particules du cnrs in2p3 umr5797"}]
EOF

Sortie

[{
    "id": 1,
    "value": [
        "Laboratoire de Physique des 2 infinis - Bordeaux",
        "LP2I - Bordeaux",
        "199512079F",
        "Institut d'écologie et environnement"
    ]
}]

V1/affiliationcountry/affiliationcountry

Ce service permet à partir d'une adresse de déteminer le pays même s'il n'est pas dans l'adresse

Prend en entrée du JSON avec deux champs: id et value, et renvoie un JSON avec le nom du pays et le code pays dans le champ value.

Exemple

cat <<EOF | curl -X POST --data-binary @- "https://address-kit.services.inist.fr/v1/affiliationcountry/affiliationcountry"

[{"id":1, "value":"université sciences et technologies bordeaux 1 institut national de physique nucléaire et de physique des particules du cnrs in2p3 UMR5797"},
{"id":2, "value":"auf der morgenstelle 8, 72076 tuebingen"}]
EOF

Sortie

[{
    "id": 1,
    "value": [
        "France",
        "FRA"
    ]
},
{
    "id": 2,
    "value": [
        "Germany",
        "DEU"
    ]
}]