API: verschil tussen versies

Uit Petities
Ga naar: navigatie, zoeken
k (Api hernoemd naar API)
(linkje naar uitgebreide lemma.)
Regel 1: Regel 1:
 +
Het ontwikkelen van de [[Application Programming Interface]] is nog in een pril stadium. Met het onderstaande zou het mogelijk moeten zijn een ondertekening in onze database te injecteren. De [[ondertekenaar]] krijgt dan een e-mail met [[bevestiging]]slink op het ingevulde e-mailadres.
 +
 
== ondertekeningen ==
 
== ondertekeningen ==
 
===POST ===
 
===POST ===

Versie van 13 jun 2010 om 23:35

Het ontwikkelen van de Application Programming Interface is nog in een pril stadium. Met het onderstaande zou het mogelijk moeten zijn een ondertekening in onze database te injecteren. De ondertekenaar krijgt dan een e-mail met bevestigingslink op het ingevulde e-mailadres.

ondertekeningen

POST

Een POST request naar:

http://api.petities.nl/api/v1/petities/[naam-gedeelte-van-petitie-uit-url]/signatures.xml

met de volgende parameters:

  • name : string; naam van ondertekenaar (verplicht)
  • email : string; e-mailadres van ondertekenaar (verplicht)
  • city : string; woonplaats van ondertekenaar
  • visibility : boolean(0/1); toon ondertekening op website

Retourneert een 200 OK met een xml-structuurtje met validatie errors, of een 200 OK met een lege body == geen errors.

Na een succesvolle ondertekening wordt er een bevestiging e-mail naar het e-mailadres gestuurd. De link in dat e-mailtje wijst naar petities.nl en haakt in op het normale ondertekenings-proces.