Documentation de demarches-simplifiees.fr
  • Généralités
  • Présentation
  • Cible
  • Démarrage
  • Cas d'usage
  • Tutoriels et vidéos
    • Tutoriel usager
    • Tutoriel « expert invité »
    • Tutoriel instructeur
    • Tutoriel administrateur
    • Les bonnes pratiques lors de la création d'une démarche
    • Vidéo : la sécurité de demarches-simplifiees.fr
    • Vidéo : le cadre juridique
    • Vidéo : la relation usager
    • Intégration du bouton « Mon avis »
  • Nouveautés
    • Pour les administrateurs
    • Pour les instructeurs
    • Pour les usagers
  • Expérimentations
    • Type de champ expression régulière
    • Chorus
  • Nos démarches
    • Démarches modèles à dupliquer
    • Démarches relatives au permis de conduire
    • Démarches relatives aux transporteurs
    • Démarches relatives au secteur du transport public de tourisme (T3P) - Taxis et VTC
    • Démarches relatives aux étrangers résidant en France
    • Démarches relatives aux inscriptions scolaires (inscription, restauration, centres de loisirs)
    • Démarches relatives aux médailles d'honneur
    • Démarches relatives aux Tribunal judiciaire de Lille
  • Conditions Générales d'Utilisation
  • Conditions générales d'utilisation : usagers
  • Politique de confidentialité
  • Mentions légales
  • API GraphQL
    • Automatisation : obligations des utilisateurs publics
    • Introduction technique
    • Accréditation
    • Le playground / Premiers pas
    • Point d'entrée et Schema GraphQL
    • Jeton d'authentification
      • Problèmes fréquents
    • Les queries
      • getDemarche
      • getDossier
      • getGroupeInstructeur
      • getDemarcheDescriptor
    • Les mutations
      • Modifier l'état d'un dossier
      • Envoyer un message
      • Ajouter ou supprimer un label
    • Pagination
    • Gestion des Erreurs
    • Cas d'usages / exemple d'implémentation
      • Client de démo en JS
      • Autentification
      • Récupérer un dossier
      • Pagination – Synchroniser une démarche à faible volumétrie (polling simple)
      • Pagination – Récupérer tous les dossiers d'une démarche
      • Pagination – Synchroniser une démarche à forte volumétrie (synchronisation)
      • Télécharger les fichiers uploadés par un usager sur son dossier
      • Envoyer un message avec une PJ
      • Accepter un dossier et y joindre un justificatif (une PJ)
      • Lister les Id des instructeurs
  • Pour aller plus loin
    • Cartographie
    • API de préremplissage
    • Aspects techniques et juridiques
    • Exports de données
    • Exports et Macros
    • Routage des dossiers
    • Webinaires
    • Horodatage
    • Archivage longue durée des démarches
    • Le conditionnel
    • Eligibilité des dossiers
    • Export personnalisé
  • Communiqués de presse
  • Expiration et suppression des dossiers
Propulsé par GitBook
Sur cette page
  • Comment accéder aux jetons ?
  • Comment créer un jeton ?
  • Comment fonctionnent les jetons ?
  • Accéder en lecture et/ou écriture à toutes les démarches de l'administrateur ayant généré le jeton
  • Accéder en lecture et/ou écriture uniquement à une liste fermée des démarches de l'administrateur ayant généré le jeton
  • Comment utiliser le jeton ?
  • GraphQL
  • Exemple de requête
Exporter en PDF
  1. API GraphQL

Jeton d'authentification

Comment fonctionne notre système d'authentification ?

PrécédentPoint d'entrée et Schema GraphQLSuivantProblèmes fréquents

Dernière mise à jour il y a 1 an

Comment accéder aux jetons ?

Connectez-vous avec votre compte administrateur et cliquez sur Voir mon profil

Comment créer un jeton ?

Cliquez sur le bouton Créer et afficher un nouveau jeton.

Attention, le jeton n'est affiché qu'à la création !

Comment fonctionnent les jetons ?

Les jetons peuvent être configurés pour :

Accéder en lecture et/ou écriture à toutes les démarches de l'administrateur ayant généré le jeton

Accéder en lecture et/ou écriture uniquement à une liste fermée des démarches de l'administrateur ayant généré le jeton

Pour des raisons de sécurité, nous recommandons l'usage de ce type de jeton qui restreint l'accès aux démarches nécessaires.

Comment utiliser le jeton ?

Ce jeton doit être fourni dans l’en-tête HTTP Authorization de la requête.

Authorization: Bearer token=valeur_du_jeton.

GraphQL

POST https://www.demarches-simplifiees.fr/api/v2/graphql

Le point d’entrée de l’API GraphQL.

Headers

Name
Type
Description

Content-Type*

string

application/json

Authorization*

string

Le jeton de l’administrateur

Request Body

Name
Type
Description

query*

string

La requête GraphQL

variables*

object

Les variables de la requête

{
    "data": {
    	"demarche": {
    	    "id": "UHJvY2VkdXJlLTYyNTE1",
	    "dossiers": {
	    	"nodes": [
		    {
		        "id": "RG9zc2llci05Mzk5MTkw",
		        "demandeur": {
			    "civilite": "M",
			    "nom": "Franklin",
			    "prenom": "Benjamin"
			}
		    },
	            {
			"id": "RG9zc2llci05NjQzMDIz",
			"demandeur": {
			    "civilite": "Mme",
		            "nom": "Curie",
			    "prenom": "Marie"
			}
		    },
		    {
			"id": "RG9zc2llci0xMzI2Njg1NQ==",
                        "demandeur": {
                            "civilite": "M",
			    "nom": "Pasteur",
			    "prenom": "Louis"
			}
		    }
		]
	    }
        }
    }
}

Exemple de requête

Pour tester que tout fonctionne bien

curl 'https://www.demarches-simplifiees.fr/api/v2/graphql' \
    --header 'Authorization: Bearer <votre_token>' \
    --header 'Content-Type: application/json' \
    --data '{ "query": "query getDemarche($demarcheNumber: Int!) { demarche(number: $demarcheNumber) { id dossiers { nodes { id demandeur { ... on PersonnePhysique { civilite nom prenom } ... on PersonneMorale { siret } } } } } }", "variables": { "demarcheNumber": <votre_numero_de_demarche> } }'

Vous devriez alors obtenir des informations en sortie. S’il y a des dossiers dans votre démarche, cette requête vous donne les noms des demandeurs. Si la démarche s’adresse à des entreprises, vous aurez le numéro SIRET des demandeurs.

Exemple si mon jeton est A9Knc34tP== avec le numéro de démarche 12345:

curl 'https://www.demarches-simplifiees.fr/api/v2/graphql' \
    --header 'Authorization: Bearer A9Knc34tP==' \
    --header 'Content-Type: application/json' \
    --data '{ "query": "query getDemarche($demarcheNumber: Int!) { demarche(number: $demarcheNumber) { id dossiers { nodes { id demandeur { ... on PersonnePhysique { civilite nom prenom } ... on PersonneMorale { siret } } } } } }", "variables": { "demarcheNumber": 12345 } }'

Voici la réponse de l'API pour cette requête :

{
    "data": {
    	"demarche": {
    	    "id": "UHJvY2VkdXJlLTYyNTE1",
	    "dossiers": {
	    	"nodes": [
		    {
		        "id": "RG9zc2llci05Mzk5MTkw",
		        "demandeur": {
			    "civilite": "M",
			    "nom": "Franklin",
			    "prenom": "Benjamin"
			}
		    },
	            {
			"id": "RG9zc2llci05NjQzMDIz",
			"demandeur": {
			    "civilite": "Mme",
		            "nom": "Curie",
			    "prenom": "Marie"
			}
		    },
		    {
			"id": "RG9zc2llci0xMzI2Njg1NQ==",
                        "demandeur": {
                            "civilite": "M",
			    "nom": "Pasteur",
			    "prenom": "Louis"
			}
		    }
		]
	    }
        }
    }
}

Si vous obtenez une erreur, vérifiez que :

  • chaque paramètre header est correct

  • il n'y a pas d'espace ou de guillemet en trop ou en moins

  • les majuscules et miniscules sont respectées

  • l'url, le jeton et le numéro de démarche sont corrects

Pour tester l’API, le plus simple est d’effectuer une requête telle que ci dessous. Le principe est le même avec un autre client HTTP : remplacez votre_token et votre_numero_de_demarche par les valeurs souhaitez, et n’oubliez pas de préciser le content-type qui est toujours application/json :

lisez le message d'erreur et consultez nos pages et

curl
Problèmes fréquents d'authentification
la gestion d'erreur
comment crééer un jeton
exemple d'un jeton qui donne accès à toutes les démarches de l'administrateur
exemple d'un jeton qui donne accès à certaines démarches de l'administrateur