Utiliser l'API

Petit guide pour utiliser l'API de NSI Rocks

Préparation

  • Obtenir un domaine : aller sur nsi.rocks/api/cours/[votre domaine]
    • à la place de votre domaine, indiquer le domaine de votre choix. Cela donnerait par exemple nsi.rocks/api/cours/formulaire-toto
    • votre domaine doit rester simple : pas d'accents, pas d'espaces, pas de ponctuation, pas de majuscules
    • des exemples : "pokemon-pref", "musique-2024", "ville-denain", etc...
  • Une clé publique et une clé privée vous est fournie, sous la forme :
Clé publique : formulaire-toto
Clé secrète : wrf7
  • ATTENTION : la clé secrète doit être conservée précieusement, et ne pas être exposée ! Si vous l'oubliez, pensez à me contacter.

Utilisation

  • Dans les champs method et action de votre fomulaire, indiquer :
<form method="post" action="https://nsi.rocks/api/cours/[clé publique]" />
  • Dans vos formulaires, ajouter un champ caché qui contient une clé API :
<input name="api" type="hidden" value="ma-clé-api" />

Consulter les données

Votre clé secrète vous permet de consulter les données. Cela permet de protéger les données, en évitant à n'importe qui de les consulter librement.
  • Depuis un script ou un navigateur, vos données sont disponibles à l'adresse https://nsi.rocks/api/cours/[clé publique]:[clé privée]