Identification pérenne ARK

En plus de l'identifiant interne à 40 caractères idIstex, les documents ISTEX se voient attribuer un identifiant appelé ARK (Archival Resource Key). Ce type d'identifiant, initié et mis en place par la “CDL” (California Digital Library), est un standard gratuit déjà utilisé par la BNF (Bibliothèque Nationale de France).

Avec ce type d'identifiant, une URL pointant vers un document ISTEX pourra être exprimé suivant la forme :

https://api.istex.fr/ark:/67375/GT4-FJLCPBW9-Q/fulltext.pdf

Au lieu de la forme classique :

https://api.istex.fr/document/087661D669BF44CA05AA6CE08ADD6399F6A439C4/fulltext/pdf

Structure d'une URL de type ARK

On peut décomposer une URL d’accès à un document ISTEX via son identifiant ARK ainsi :

Première partie du schéma

On peut voir sur ce schéma que le cœur de l’URL est son « nom ARK » (encadré rouge), partie identifiant de manière unique ce document parmi l’ensemble des ARK existant par ailleurs.

Pour en savoir plus sur les ARK, n'hésitez pas à consulter le site de la BNF.

Intérêt des ARK dans ISTEX

La mise en place des ARK a de nombreux avantages, dont la gratuité d’attribution contrairement au DOI.

D’autres avantages sont :

  1. La citabilité facilitée, grâce à une chaîne de caractères plus petite que l’identifiant ISTEX à 40 caractères.
  2. La lisibilité améliorée, grâce à une hiérarchisation bien identifiée :
  3. Le NAAN, numéro attribué par la CDL, qui identifie l’institution habilitée à attribuer des ARK (67375 pour l’INIST-CNRS).
  4. Le Subpublisher, première partie de l’ARK, qui caractérise le bouquet éditeur ( GT4 pour le corpus « Nature »).
  5. Une identification de la typologie du document (fulltext) et du format (pdf), rendue possible par les qualificatifs.

Enfin, pour vous garantir la pérennité des identifiants ARK, nous avons mis en place des moyens techniques adéquats, avec notamment des sauvegardes quotidiennes.

Emplacement des ARK

Un identifiant ARK, lorsqu'il a été attribué à un document ISTEX, se retrouve à différents niveaux :

Dans le format MODS

Dans ce format, il se retrouve aux côtés des autres identifiants dans l'élément <identifier type="ark"> :

...
</relatedItem>
<identifier type="istex">087661D669BF44CA05AA6CE08ADD6399F6A439C4</identifier>
<identifier type="ark">ark:/67375/GT4-FJLCPBW9-Q</identifier>
<identifier type="DOI">...</identifier>
<identifier type="ArticleID">...</identifier>
<accessCondition>...

Dans le format TEI

Comme dans le MODS, il se retrouve aux côtés des autres identifiants dans l'élément <idno type="ark"> :

...
<sourceDesc>
  <biblStruct type="abstract">
    <analytic>
      <title level="a" type="main">...</title>
      <idno type="istex">087661D669BF44CA05AA6CE08ADD6399F6A439C4</idno>
      <idno type="ark">ark:/67375/GT4-FJLCPBW9-Q</idno>
      <idno type="DOI">...</idno>
      <idno type="unit">...</idno>
    </analytic>
    ...
  </biblStruct>
  ...
</sourceDesc>
...

Dans le format JSON

Dans ce format, il se retrouve à la racine de la structure représentant le document (article ou chapitre) dans le champ arkIstex :

{

    "corpusName": "nature",
    "arkIstex": "ark:/67375/GT4-FJLCPBW9-Q",
    "language": [
        "eng"
    ],
    "title": "Orphan nuclear receptor TLX activates Wnt/-catenin signalling to stimulate neural stem cell proliferation and self-renewal",
    ...
}

On notera également la présence dans ce format d'un champ multi-valué ark. Contrairement à arkIstex, ce champ pourra contenir plusieurs identifiants ARK, dans le cas où plusieurs autorités auraient attribué un ARK au même document.

URL d'accès dans l'API

Dans une URL d'accès de type ARK, l'utilisation des qualificatifs permet de sélectionner une typologie et/ou un format pour un document donné. Selon le niveau de précision de l'URL, l'API renverra :

  • soit le document demandé dans le format sélectionné
  • soit la liste des formats disponibles pour la typologie sélectionnée
  • soit la liste des typologies et formats disponibles pour le document sélectionné

Liste des typologies et formats disponibles

Syntaxe
URI https://api.istex.fr/67375/{nom-ark}
Paramètres - {nom-ark} : le nom ark ISTEX du document auquel correspond la notice (ex : GT4-FJLCPBW9-Q)
Code de retour - 200 si OK,
- 400 si le nom ark est invalide (nombre de caractère incorrect ou caractère de contrôle incorrect, par exemple)
- 404 si le nom ark n'est pas trouvé dans la plateforme ISTEX
Exemple https://api.istex.fr/ark:/67375/GT4-FJLCPBW9-Q

Format de la réponse :


{

    "_comment": "Objet documentaire identifié par l'indentifiant ARK ark:/67375/GT4-FJLCPBW9-Q. Liste des typologies et formats disponibles correspondant",
    "idIstex": "087661D669BF44CA05AA6CE08ADD6399F6A439C4",
    "arkIstex": "67375/GT4-FJLCPBW9-Q",
    "title": "Orphan nuclear receptor TLX activates Wnt/-catenin signalling to stimulate neural stem cell proliferation and self-renewal",
    "typologies": {
        "bundle": [
            {
                "format": "zip",
                "mimetype": "application/zip",
                "uri": "https://api.istex.fr/ark:/67375/GT4-FJLCPBW9-Q/bundle.zip"
            }
        ],
        "fulltext": [
            {
                "format": "pdf",
                "mimetype": "application/pdf",
                "uri": "https://api.istex.fr/ark:/67375/GT4-FJLCPBW9-Q/fulltext.pdf"
            },
            {
                "format": "tei",
                "mimetype": "application/tei+xml",
                "uri": "https://api.istex.fr/ark:/67375/GT4-FJLCPBW9-Q/fulltext.tei"
            },
            {
                "format": "txt",
                "mimetype": "text/plain",
                "uri": "https://api.istex.fr/ark:/67375/GT4-FJLCPBW9-Q/fulltext.txt"
            }
        ],
        "record": [
            {
                "format": "json",
                "mimetype": "application/json",
                "uri": "https://api.istex.fr/ark:/67375/GT4-FJLCPBW9-Q/record.json"
            },
            {
                "format": "mods",
                "mimetype": "application/mods+xml",
                "uri": "https://api.istex.fr/ark:/67375/GT4-FJLCPBW9-Q/record.mods"
            },
            {
                "format": "xml",
                "mimetype": "application/xml",
                "uri": "https://api.istex.fr/ark:/67375/GT4-FJLCPBW9-Q/record.xml"
            }
        ]
    }

}

Liste des formats disponibles pour une typologie donnée

Syntaxe
URI https://api.istex.fr/67375/{nom-ark}/{typologie}
Paramètres - {nom-ark} : le nom ark ISTEX du document auquel correspond la notice (ex : GT4-FJLCPBW9-Q)
- {typologie} : la typologie demandée
Code de retour - 200 si OK,
- 400 si le nom ark est invalide (nombre de caractère incorrect ou caractère de contrôle incorrect, par exemple)
- 404 si la typologie demandée n'est pas disponible ou si le nom ark n'est pas trouvé dans la plateforme ISTEX
Exemple https://api.istex.fr/ark:/67375/GT4-FJLCPBW9-Q/record

Format de la réponse :

{

    "_comment": "Objet documentaire identifié par l'indentifiant ARK ark:/67375/GT4-FJLCPBW9-Q. Liste des formats disponibles correspondant à la typologie 'record' pour ce document ",
    "idIstex": "087661D669BF44CA05AA6CE08ADD6399F6A439C4",
    "arkIstex": "ark:/67375/GT4-FJLCPBW9-Q",
    "title": "Orphan nuclear receptor TLX activates Wnt/-catenin signalling to stimulate neural stem cell proliferation and self-renewal",
    "formats": [
        {
            "format": "json",
            "mimetype": "application/json",
            "uri": "https://api-dev.istex.fr/ark:/67375/GT4-FJLCPBW9-Q/record.json"
        },
        {
            "format": "mods",
            "mimetype": "application/mods+xml",
            "uri": "https://api-dev.istex.fr/ark:/67375/GT4-FJLCPBW9-Q/record.mods"
        },
        {
            "format": "xml",
            "mimetype": "application/xml",
            "uri": "https://api-dev.istex.fr/ark:/67375/GT4-FJLCPBW9-Q/record.xml"
        }
    ]

}

Accès direct au format demandé

Syntaxe
Paramètres - {nom-ark} : le nom ark ISTEX du document auquel correspond la notice (ex : GT4-FJLCPBW9-Q)
- {typologie} : la typologie demandée
- {format} : le format demandé
Code de retour - 200 si OK,
- 400 si le nom ark est invalide (nombre de caractère incorrect ou caractère de contrôle incorrect, par exemple)
- 404 si le format ou la typologie demandé n'est pas disponible ou si le nom ark n'est pas trouvé dans la plateforme ISTEX
Exemple https://api.istex.fr/ark:/67375/GT4-FJLCPBW9-Q/record.json

En retour, l'API renverra le document dans le format souhaité dans le corps de la réponse.