API

Pd
Te
Last updated 3 days ago

Généralité

L'API de demarches-simplifiees.fr permet de consulter :

  • les informations d'une démarches,

  • la liste des dossiers d'une démarche,

  • les détails d'un dossier spécifique.

Elle ne permet pour l'instant que de consulter des informations (mais pas de les modifier).

L'API est accessible à l'aide d'adresse commençant par https://www.demarches-simplifiees.fr/api/v1. Elle suit le paradigme REST en répondant en JSON sur une couche HTTPS.

Un lien de rappel HTTP (aussi appelé « webhook ») peut être utilisé pour notifier un service tiers du changement de l'état d’un dossier sur demarches-simplifiees.fr. Consulter la documentation du webhook.

Authentification

Tous les appels sont authentifiés et doivent donc fournir un jeton valide qui est accessible dans la partie profil de l'administrateur. Ce jeton peut être fourni :

  • soit en paramètre d'URL avec token=valeur_du_jeton

  • soit avec le header Authorization: Bearer token=valeur_du_jeton.

Ainsi, une url valide pour récupérer le dossier 321 sur la procédure 123 avec le jeton jeton_de_securite est le suivant : https://www.demarches-simplifiees.fr/api/v1/procedures/123/dossiers/321?token=jeton_de_securite

get
procedures/:procedure_id

https://www.demarches-simplifiees.fr/api/v1/procedures/:procedure_id
Informations concernant une démarche
Request
Response
Path Parameters
procedure_id
required
number
Numéro de la démarche
Query Parameters
token
optional
string
Valeur du jeton
200: OK
{
"procedure": {
"label": "Demande de subvention",
"link": "http://localhost",
"id": 3,
"state": "publiee",
"description": "Demande de subvention à l'intention des associations",
"organisation": "Orga DINSIC",
"direction": "direction DINSIC",
"archived_at": null,
"geographic_information": {
"use_api_carto": true,
"quartiers_prioritaires": true,
"cadastre": true
},
"types_de_champ": [
{
"id": 3,
"libelle": "Description",
"type": "textarea",
"order_place": 1,
"description": "description de votre projet"
}
],
"types_de_piece_justificative": [
{
"id": 5,
"libelle": "RIB",
"description": "Releve identité bancaire"
},
{
"id": 6,
"libelle": "Attestation MSA",
"description": "recuperation automatique"
}
]
}
}
401: Unauthorized
Non authorisé
404: Not Found
Démarche inconnue

get
/procedures/:procedure_id/dossiers

https://www.demarches-simplifiees.fr/api/v1/procedures/:procedure_id/dossiers
Liste de tous les dossiers d'une démarche
Request
Response
Path Parameters
procedure_id
required
number
Numéro de la démarche
Query Parameters
page
optional
number
Numéro de la page
resultats_par_page
optional
number
Nombre de résultats par page (100 par défaut, maximum 1 000)
token
optional
string
Valeur du jeton
200: OK
{
"dossiers": [
{
"id": 2,
"nom_projet": "Demande de subvention dans le cadre d'accompagnement d'enfant à l'étranger",
"updated_at": "2008-09-01T08:05:00.000Z",
"initiated_at": "2008-09-02T08:05:00.000Z"
"state": "initiated"
}
],
"pagination": {
"page": 1,
"resultats_par_page": 12,
"nombre_de_page": 1
}
}
401: Unauthorized
Non authorisé
404: Not Found
Démarche inconnue

get
/:procedure_id/dossiers/:dossier_id

https://www.demarches-simplifiees.fr/api/v1/procedures/:procedure_id/dossiers/:dossier_id
Informations sur un dossier d'une démarche
Request
Response
Path Parameters
procedure_id
required
number
Numéro de la démarche
dossier_id
required
number
Numéro du dossier
Query Parameters
Token
optional
string
Valeur du jeton
200: OK
{
"dossier": {
"id": 1,
"nom_projet": "Demande de subvention dans le cadre d'accompagnement d'enfant à l'étranger",
"description": "Ma super description",
"created_at": "2008-09-01T08:05:00.000Z",
"updated_at": "2008-09-01T08:05:00.000Z",
"archived": false,
"state": "initiated",
"simplified_state": "En construction",
"initiated_at": "2017-04-11T12:00:12.000Z",
"received_at": null,
"processed_at": null,
"motivation": null,
"instructeurs": [
"gestionnaire@apientreprise.fr"
],
"individual": {
"nom": "Monmari",
"prenom": "René"
},
"entreprise": {
"siren": "440117620",
"capital_social": 537100000,
"numero_tva_intracommunautaire": "FR27440117620",
"forme_juridique": "SA à conseil d'administration (s.a.i.)",
"forme_juridique_code": "5599",
"nom_commercial": "GRTGAZ",
"raison_sociale": "GRTGAZ",
"siret_siege_social": "44011762001530",
"code_effectif_entreprise": "51",
"date_creation": "2016-01-28T10:16:29.000Z",
"nom": null,
"prenom": null
},
"etablissement": {
"siret": "44011762001530",
"siege_social": true,
"naf": "4950Z",
"libelle_naf": "Transports par conduites",
"adresse": "GRTGAZ\r IMMEUBLE BORA\r 6 RUE RAOUL NORDLING\r 92270 BOIS COLOMBES\r",
"numero_voie": "6",
"type_voie": "RUE",
"nom_voie": "RAOUL NORDLING",
"complement_adresse": "IMMEUBLE BORA",
"code_postal": "92270",
"localite": "BOIS COLOMBES",
"code_insee_localite": "92009"
},
"cerfa": null,
"champs": [
{
"value": null,
"type_de_champ": {
"id": 1,
"libelle": "Description",
"type": "textarea",
"order_place": 1,
"description": "description de votre projet"
}
},
{
"value": {
"type": "MultiPolygon",
"coordinates": [
[
[
[
2.3050735,
48.8401501
],
[
2.3052329,
48.8402106
],
[
2.3053759,
48.8400422
],
[
2.3050735,
48.8401501
]
]
]
]
},
"type_de_champ": {
"id": -1,
"libelle": "cadastre",
"type_champ": "cadastre",
"order_place": -1,
"descripton": ""
}
},
{
"value": {
"type": "MultiPolygon",
"coordinates": [
[
[
[
2.3050735,
48.8401501
],
[
2.3052329,
48.8402106
],
[
2.3053759,
48.8400422
],
[
2.3050735,
48.8401501
]
]
]
]
},
"type_de_champ": {
"id": -1,
"libelle": "quartier prioritaire",
"type_champ": "quartier_prioritaire",
"order_place": -1,
"descripton": ""
}
},
{
"value": {
"type": "MultiPolygon",
"coordinates": [
[
[
[
2.3049509525299072,
48.84028511554904
],
[
2.305165529251098,
48.84014035882062
],
[
2.3049670457839966,
48.84005562298059
],
[
2.3049509525299072,
48.84028511554904
]
]
]
]
},
"type_de_champ": {
"id": -1,
"libelle": "user_geometry",
"type_champ": "user_geometry",
"order_place": -1,
"descripton": ""
}
}
],
"champs_private": [
{
"value": null,
"type_de_champ": {
"id": 1,
"libelle": "Description privée",
"type_champ": "text",
"order_place": 0,
"description": "description privée"
}
}
],
"pieces_justificatives": [
{
"url": null,
"type_de_piece_justificative": {
"id": 1,
"libelle": "RIB",
"description": "Releve identité bancaire"
}
},
{
"url": null,
"type_de_piece_justificative": {
"id": 2,
"libelle": "Attestation MSA",
"description": "recuperation automatique"
}
}
]
}
}
401: Unauthorized
Non authorisé
404: Not Found
Démarche ou dossier inconnu