Skip to content

Commit

Permalink
WIP API collection
Browse files Browse the repository at this point in the history
  • Loading branch information
noirbizarre committed Oct 10, 2018
1 parent 26af61b commit ffef646
Show file tree
Hide file tree
Showing 4 changed files with 31 additions and 0 deletions.
14 changes: 14 additions & 0 deletions _api/authentification.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
title: Authentification
---

# Authentification

De façon à pouvoir exécuter des opérations d'écriture, vous devez commencer par obtenir une [clé d'API](https://www.data.gouv.fr/fr/admin/me/#apikey) dans les paramètres de votre profil.

Cette clé doit être fournie à chaque appel dans l'entête HTTP `X-API-KEY`.

## Autorisations
Les appels d'API sont soumis aux même permissions que l'interface web.

Par exemple, vous devez être membre de l'organisation pour modifier l'un de ses jeux de données.
5 changes: 5 additions & 0 deletions _api/dataset-workflow.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: Gestion d'un jeu de données
---

# Gestion d'un jeu de données par l'API
4 changes: 4 additions & 0 deletions _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,10 @@ collections:
title: Découvrir l'OpenData
output: true
order: 1
api:
title: API
output: true
order: 2


defaults:
Expand Down
8 changes: 8 additions & 0 deletions admin/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,11 @@ collections:
- {label: "Sous-titre", name: "subtitle", widget: "string"}
- {label: "Libellé (du menu)", name: "label", widget: "string"}
- {label: "Contenu", name: "body", widget: "markdown"}

- name: api
label: API
folder: _api
create: true
fields:
- {label: "Titre", name: "title", widget: "string"}
- {label: "Contenu", name: "body", widget: "markdown"}

0 comments on commit ffef646

Please sign in to comment.