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
Exporter en PDF
  1. API GraphQL

Point d'entrée et Schema GraphQL

PrécédentLe playground / Premiers pasSuivantJeton d'authentification

Dernière mise à jour il y a 8 mois

Vous avez maintenant les pré-requis pour avancer sur votre propre client des API de Démarche Simplifiées :

  • vous disposez d'un compte administrateur sur demarches-simplifiees.fr

  • vous avez une démarche de test publiée (vous pouvez en créer une)

  • vous arrivez à structurer des appels à l'API en combinant la query qui détermine les données que vous souhaitez récupérer, et les variables qui déterminent la logique métier que nous devons appliquer. Bref, vous avez pris vos aises sur le playground, avec votre démarche de test et votre compte administrateur.

Vous pouvez maintenant ouvrir votre éditeur de code préféré et garder en tête que :

Les requêtes sont à envoyer au endpoint : https://www.demarches-simplifiees.fr/api/v2/graphql

Les requêtes doivent être envoyées avec le verbe HTTP POST

Les headers doivent contenir le jeton d'authentification au format attendu confère : jeton d'authentification

Le corps de votre requete POST, doit être un JSON respectant la spécification GraphQL

Cette adresse n’est pas visitable dans un navigateur. Elle renvoie des données au format JSON, à travers un transport HTTPS.

Pour plus d'information concernant le schema, vous pouvez:

  • consulter la documentation : https://www.demarches-simplifiees.fr/graphql/schema/index.html

  • consulter le fichier graphql.schema : https://github.com/demarches-simplifiees/demarches-simplifiees.fr/blob/main/app/graphql/schema.graphql

  • utiliser GraphiQL explorer du playground : https://www.demarches-simplifiees.fr/graphql/