Accès aux métadonnées
Toutes les URL suivantes sont accédées via la méthode HTTP GET.
Les URL d'accès aux métadonnées sont de la forme :
| Syntaxe |
|------------ | ------------- |
| URI | https://api.istex.fr/document/{id}/metadata/{ext} |
| Paramètres | - {id} : l'identifiant ISTEX du document auquel correspond la notice,
- {ext} : extension du fichier souhaité (ex : "xml"). |
| Code de retour | - 200 si OK,
- 404 si le fichier n'est pas trouvé|
| Détails | La liste des formats disponibles pour un objet documentaire est accessible si on ne précise pas d'extension.
On obtiendra alors un JSON avec la liste des fichiers disponibles, par exemple :
{Pour plus de détails sur les champs envoyés en réponse, consultez le chapitre correspondant.
id: "55420CDEEA0F6538E215A511C72E2E5E57570138",
metadata: [
{
original: true,
mimetype: "application/xml",
extension: "xml",
uri: "https://api.istex.fr/document/55420CDEEA0F6538E215A511C72E2E5E57570138/metadata/xml"
},
{
original: false,
mimetype: "application/mods+xml",
extension: "mods",
uri: "https://api.istex.fr/document/55420CDEEA0F6538E215A511C72E2E5E57570138/metadata/mods"
}
]
}
Il est possible de demander directement la notice fournie par l'éditeur en précisant comme extension "original".| | Formats existants | - XML, MODS. | | Exemple | https://api.istex.fr/document/55420CDEEA0F6538E215A511C72E2E5E57570138/metadata
https://api.istex.fr/document/55420CDEEA0F6538E215A511C72E2E5E57570138/metadata/mods
https://api.istex.fr/document/55420CDEEA0F6538E215A511C72E2E5E57570138/metadata/original
Accès aux fulltext
Toutes les URL suivantes sont accédées via la méthode HTTP GET.
Les URL d'accès aux fulltext sont de la forme :
| Syntaxe |
|------------ | ------------- |
| URI | https://api.istex.fr/document/{id}/fulltext/{ext} |
| Paramètres | - {id} : l'identifiant ISTEX du document auquel correspond la notice,
- {ext} : extension du fichier souhaité (ex : "pdf"). |
| Code de retour | - 200 si OK,
- 404 si le fichier n'est pas trouvé|
| Détails | La liste des formats disponibles pour un objet documentaire est accessible si on ne précise pas d'extension.
On obtiendra alors un JSON avec la liste des fichiers disponibles, par exemple :
{Pour plus de détails sur les champs envoyés en réponse, consultez le chapitre correspondant.
id: "55420CDEEA0F6538E215A511C72E2E5E57570138",
fulltext: [
{
original: true,
mimetype: "application/pdf",
extension: "pdf",
uri: "https://api.istex.fr/document/55420CDEEA0F6538E215A511C72E2E5E57570138/fulltext/pdf"
},
{
original: false,
mimetype: "application/tei+xml",
extension: "tei",
uri: "https://api.istex.fr/document/55420CDEEA0F6538E215A511C72E2E5E57570138/fulltext/tei"
}
]
}
Il est possible de demander directement le(s) document(s) fourni(s) par l'éditeur en précisant comme extension "original".
Si plusieurs documents d'un format (ex: plusieurs pages TIFF) existent, ils sont renvoyés dans une archive au format ZIP.| | Formats existants | - PDF, TEI, TXT, ZIP, TIFF. | | Exemple | https://api.istex.fr/document/55420CDEEA0F6538E215A511C72E2E5E57570138/fulltext
https://api.istex.fr/document/55420CDEEA0F6538E215A511C72E2E5E57570138/fulltext/pdf
https://api.istex.fr/document/55420CDEEA0F6538E215A511C72E2E5E57570138/fulltext/original
Accès aux annexes
Toutes les URL suivantes sont accédées via la méthode HTTP GET.
Les URL d'accès aux annexes sont de la forme :
| Syntaxe |
|------------ | ------------- |
| URI | https://api.istex.fr/document/{id}/annexes/{ext} |
| Paramètres | - {id} : l'identifiant ISTEX du document auquel correspond la notice,
- {ext} : extension du fichier souhaité (ex : "pdf"). |
| Code de retour | - 200 si OK,
- 404 si le fichier n'est pas trouvé|
| Détails | La liste des formats disponibles pour un objet documentaire est accessible si on ne précise pas d'extension.
On obtiendra alors un JSON avec la liste des fichiers disponibles, par exemple :
{Si le document interrogé ne possède aucun annexe, l'API renverra un message JSON, comme :
id: "087661D669BF44CA05AA6CE08ADD6399F6A439C4",
annexes: [
{
original: true,
mimetype: "application/pdf",
extension: "pdf",
uri: "https://api.istex.fr/document/55420CDEEA0F6538E215A511C72E2E5E57570138/annexes/pdf"
},
{
original: true,
mimetype: "image/jpeg",
extension: "jpeg",
uri: "https://api.istex.fr/document/55420CDEEA0F6538E215A511C72E2E5E57570138/annexes/jpeg"
}
]
}
{Pour plus de détails sur les champs envoyés en réponse, consultez le chapitre correspondant.
id: "55420CDEEA0F6538E215A511C72E2E5E57570138",
_error: "Il n'existe actuellement aucun résultat pour ce type de data"
}
Si plusieurs documents d'un format (ex: plusieurs JPEG) existent, ils sont renvoyés dans une archive au format ZIP.| | Formats existants | - PDF, JPEG, QT, PTT, XLS, AVI, XML, GIF, WMV. | | Exemple | https://api.istex.fr/document/55420CDEEA0F6538E215A511C72E2E5E57570138/annexes
https://api.istex.fr/document/087661D669BF44CA05AA6CE08ADD6399F6A439C4/annexes
https://api.istex.fr/document/087661D669BF44CA05AA6CE08ADD6399F6A439C4/annexes/pdf
Accès aux couvertures
Toutes les URL suivantes sont accédées via la méthode HTTP GET.
Les URL d'accès aux couvertures sont de la forme :
| Syntaxe |
|------------ | ------------- |
| URI | https://api.istex.fr/document/{id}/covers/{ext} |
| Paramètres | - {id} : l'identifiant ISTEX du document auquel correspond la notice,
- {ext} : extension du fichier souhaité (ex : "gif"). |
| Code de retour | - 200 si OK,
- 404 si le fichier n'est pas trouvé|
| Détails | La liste des formats disponibles pour un objet documentaire est accessible si on ne précise pas d'extension.
On obtiendra alors un JSON avec la liste des fichiers disponibles, par exemple :
{Si le document interrogé ne possède aucune couverture, l'API renverra un message JSON, comme :
id: "087661D669BF44CA05AA6CE08ADD6399F6A439C4",
covers: [
{
original: true,
mimetype: "image/gif",
extension: "gif",
uri: "https://api.istex.fr/document/55420CDEEA0F6538E215A511C72E2E5E57570138/covers/gif"
}
]
}
{Pour plus de détails sur les champs envoyés en réponse, consultez le chapitre correspondant.
id: "55420CDEEA0F6538E215A511C72E2E5E57570138",
_error: "Il n'existe actuellement aucun résultat pour ce type de data"
}
Si plusieurs documents d'un format (ex: plusieurs JPEG) existent, ils sont renvoyés dans une archive au format ZIP.| | Formats existants | - PDF, GIF, JPEG. | | Exemple | https://api.istex.fr/document/55420CDEEA0F6538E215A511C72E2E5E57570138/covers
https://api.istex.fr/document/087661D669BF44CA05AA6CE08ADD6399F6A439C4/covers
https://api.istex.fr/document/087661D669BF44CA05AA6CE08ADD6399F6A439C4/covers/gif