REST API: verschil tussen versies
k (→Facturen en betalingen) |
(Bijwerken REST endpoints /myAccount -> /accounts/~) |
||
| (2 tussenliggende versies door een andere gebruiker niet weergegeven) | |||
| Regel 2: | Regel 2: | ||
Alle genoemde URIs zijn relatief t.o.v. de root van de API server. | Alle genoemde URIs zijn relatief t.o.v. de root van de API server. | ||
| + | |||
| + | == Authoritief == | ||
| + | |||
| + | {| class="wikitable" | ||
| + | ! colspan=3 | Authoritief | ||
| + | |- | ||
| + | | '''Methode''' || '''URI''' || '''Omschrijving''' | ||
| + | |- | ||
| + | | GET || /token || Sessie-identificatietoken opvragen voor gebruik van de API | ||
| + | |- | ||
| + | | POST || /authenticate/password || Sessie inloggen als een gebruiker d.m.v. gebruikersnaam en wachtwoord | ||
| + | |- | ||
| + | | POST || /authenticate/oauth || OAuth-authenticatietokens aanvragen voor externe authenticatie | ||
| + | |- | ||
| + | | POST || /authenticate/ssl || Sessie inloggen als een gebruiker d.m.v. SSL-clientcertificaat | ||
| + | |- | ||
| + | | POST || /token/expire || Sessie-identificatietoken vergeten | ||
| + | |} | ||
== Persoonsgegevens == | == Persoonsgegevens == | ||
| Regel 10: | Regel 28: | ||
| '''Methode''' || '''URI''' || '''Rol''' || '''Omschrijving''' | | '''Methode''' || '''URI''' || '''Rol''' || '''Omschrijving''' | ||
|- | |- | ||
| − | | POST || / | + | | POST || /accounts/~/requestFullDump/email || Gebruiker || Opvragen van alle persoonlijke gegevens via e-mail |
|- | |- | ||
| − | | POST || / | + | | POST || /accounts/~/requestFullDump/cdBySnailmail || Gebruiker || Opvragen van alle persoonlijke gegevens op een CD via de post |
|- | |- | ||
| POST || /accounts/{accountId}/requestFullDump/email || Medewerker || Opvragen van alle persoonlijke gegevens van een gebruiker via e-mail | | POST || /accounts/{accountId}/requestFullDump/email || Medewerker || Opvragen van alle persoonlijke gegevens van een gebruiker via e-mail | ||
| Regel 27: | Regel 45: | ||
| '''Methode''' || '''URI''' || '''Rol''' || '''Omschrijving''' | | '''Methode''' || '''URI''' || '''Rol''' || '''Omschrijving''' | ||
|- | |- | ||
| − | | GET || / | + | | GET || /accounts/~/invoices || Gebruiker || Opvragen van alle facturen op het huidige account |
|- | |- | ||
| − | | GET || / | + | | GET || /accounts/~/invoices/{invoiceId} || Gebruiker || Opvragen van gegevens van een factuur |
|- | |- | ||
| GET || /accounts/{accountId}/invoices || Medewerker || Opvragen van alle facturen op het account van een gebruiker | | GET || /accounts/{accountId}/invoices || Medewerker || Opvragen van alle facturen op het account van een gebruiker | ||
| Regel 37: | Regel 55: | ||
| PUT || /accounts/{accountId}/invoices/{invoiceId} || Medewerker, Facturatie || Aanmaken van nieuwe factuur op het account van een gebruiker | | PUT || /accounts/{accountId}/invoices/{invoiceId} || Medewerker, Facturatie || Aanmaken van nieuwe factuur op het account van een gebruiker | ||
|- | |- | ||
| − | | GET || / | + | | GET || /accounts/~/payments || Gebruiker || Opvragen van alle verwerkte betalingen op het huidige account |
|- | |- | ||
| − | | GET || / | + | | GET || /accounts/~/payments/{invoiceId} || Gebruiker || Opvragen van gegevens van een enkele betaling |
|- | |- | ||
| GET || /accounts/{accountId}/payments || Medewerker || Opvragen van alle verwerkte betalingen op het account van een gebruiker | | GET || /accounts/{accountId}/payments || Medewerker || Opvragen van alle verwerkte betalingen op het account van een gebruiker | ||
| Regel 54: | Regel 72: | ||
| '''Methode''' || '''URI''' || '''Rol''' || '''Omschrijving''' | | '''Methode''' || '''URI''' || '''Rol''' || '''Omschrijving''' | ||
|- | |- | ||
| − | | GET || / | + | | GET || /accounts/~/settings/directDebit/enabled || Gebruiker || Opvragen of automatische incasso's ingeschakeld zijn |
|- | |- | ||
| − | | POST || / | + | | POST || /accounts/~/settings/directDebit/disable || Gebruiker || Automatische incasso's uitschakelen |
|- | |- | ||
| − | | POST || / | + | | POST || /accounts/~/settings/directDebit/enable || Gebruiker || Automatische incasso's inschakelen |
|- | |- | ||
| GET || /accounts/{accountId}/settings/directDebit/enabled || Medewerker || Opvragen of automatische incasso's ingeschakeld zijn voor het account van een gebruiker | | GET || /accounts/{accountId}/settings/directDebit/enabled || Medewerker || Opvragen of automatische incasso's ingeschakeld zijn voor het account van een gebruiker | ||
Huidige versie van 11 okt 2012 om 21:18
Deze pagina bevat alle API's die geïmplementeerd moeten worden door het informatiesysteem. Deze API moet voldoende mogelijkheden bieden om alle Use cases mogelijk te maken.
Alle genoemde URIs zijn relatief t.o.v. de root van de API server.
Authoritief
| Authoritief | ||
|---|---|---|
| Methode | URI | Omschrijving |
| GET | /token | Sessie-identificatietoken opvragen voor gebruik van de API |
| POST | /authenticate/password | Sessie inloggen als een gebruiker d.m.v. gebruikersnaam en wachtwoord |
| POST | /authenticate/oauth | OAuth-authenticatietokens aanvragen voor externe authenticatie |
| POST | /authenticate/ssl | Sessie inloggen als een gebruiker d.m.v. SSL-clientcertificaat |
| POST | /token/expire | Sessie-identificatietoken vergeten |
Persoonsgegevens
| Persoonsgegevens | |||
|---|---|---|---|
| Methode | URI | Rol | Omschrijving |
| POST | /accounts/~/requestFullDump/email | Gebruiker | Opvragen van alle persoonlijke gegevens via e-mail |
| POST | /accounts/~/requestFullDump/cdBySnailmail | Gebruiker | Opvragen van alle persoonlijke gegevens op een CD via de post |
| POST | /accounts/{accountId}/requestFullDump/email | Medewerker | Opvragen van alle persoonlijke gegevens van een gebruiker via e-mail |
| POST | /accounts/{accountId}/requestFullDump/cdBySnailmail | Medewerker | Opvragen van alle persoonlijke gegevens van een gebruiker op een CD via de post |
Facturen en betalingen
| Facturen en betalingen | |||
|---|---|---|---|
| Methode | URI | Rol | Omschrijving |
| GET | /accounts/~/invoices | Gebruiker | Opvragen van alle facturen op het huidige account |
| GET | /accounts/~/invoices/{invoiceId} | Gebruiker | Opvragen van gegevens van een factuur |
| GET | /accounts/{accountId}/invoices | Medewerker | Opvragen van alle facturen op het account van een gebruiker |
| GET | /accounts/{accountId}/invoices/{invoiceId} | Medewerker | Opvragen van gegevens van een factuur op het account van een gebruiker |
| PUT | /accounts/{accountId}/invoices/{invoiceId} | Medewerker, Facturatie | Aanmaken van nieuwe factuur op het account van een gebruiker |
| GET | /accounts/~/payments | Gebruiker | Opvragen van alle verwerkte betalingen op het huidige account |
| GET | /accounts/~/payments/{invoiceId} | Gebruiker | Opvragen van gegevens van een enkele betaling |
| GET | /accounts/{accountId}/payments | Medewerker | Opvragen van alle verwerkte betalingen op het account van een gebruiker |
| GET | /accounts/{accountId}/payments/{paymentId} | Medewerker | Opvragen van gegevens van een enkele betaling op het account van een gebruiker |
Automatische incasso's
| Automatische incasso's | |||
|---|---|---|---|
| Methode | URI | Rol | Omschrijving |
| GET | /accounts/~/settings/directDebit/enabled | Gebruiker | Opvragen of automatische incasso's ingeschakeld zijn |
| POST | /accounts/~/settings/directDebit/disable | Gebruiker | Automatische incasso's uitschakelen |
| POST | /accounts/~/settings/directDebit/enable | Gebruiker | Automatische incasso's inschakelen |
| GET | /accounts/{accountId}/settings/directDebit/enabled | Medewerker | Opvragen of automatische incasso's ingeschakeld zijn voor het account van een gebruiker |
| POST | /accounts/{accountId}/settings/directDebit/disable | Medewerker | Automatisch incasso's uitschakelen voor het account van een gebruiker |
