API: verschil tussen versies
(→GET: je kan er een tellertje op baseren) |
|||
| 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. Ook is het mogelijk om informatie op te vragen over specifieke petities. | 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. Ook is het mogelijk om informatie op te vragen over specifieke petities. | ||
| − | Er is al minstens één petitionaris geweest die de API met succes heeft weten te gebruiken met [http:// | + | Er is al minstens één petitionaris geweest die de API met succes heeft weten te gebruiken met [http://handboek.petities.nl/dl/widget.zip javascript en html]. |
== ondertekeningen == | == ondertekeningen == | ||
Versie van 23 feb 2015 om 16:05
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. Ook is het mogelijk om informatie op te vragen over specifieke petities.
Er is al minstens één petitionaris geweest die de API met succes heeft weten te gebruiken met javascript en html.
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 errors-array in xml met validatie errors, of een 200 OK met een lege errors-array wanneer de ondertekening succesvol is opgeslagen.
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.
petities
GET
Een GET request naar:
http://api.petities.nl/api/v1/petities/[naam-gedeelte-van-petitie-uit-url].xml
geeft een XML document terug met informatie over de petitie. Het bevat:
- name : string; de volledige naam van de petitie
- description : text; een korte beschrijving van de petitie
- signatures_count : integer; het aantal bevestigde ondertekeningen van de petitie
- petitioner_name : string; de naam van de petitionaris
- petitioner_organisation : string; de organisatie van de petitionaris (indien ingevuld)
- date_projected : date; verwachte datum van indiening
- initiators : text; petitietekst, onderdeel 'Wij,'
- statement : text; petitietekst, onderdeel 'Constateren,'
- request : text; petitietekst, onderdeel 'en verzoeken,'
Hier is dus bijvoorbeeld een tellertje op te baseren op een andere website te plaatsen.
