-
Notifications
You must be signed in to change notification settings - Fork 0
/
apiary.apib
680 lines (558 loc) · 18.5 KB
/
apiary.apib
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
FORMAT: 1A
HOST: https://www.fcpe-norma.fr/api/
# fcpe
FCPE est une API permettant au site "FCPE Adhésion en ligne" de créer de nouvelles adhésions dans l'application FCPE Norma.
Elle permet également de gérer l'authentification des foyers existants, de modifier leur mot de passe.
Cette API est succeptible d'évoluer et d'être utilisée par d'autres sites de la FCPE.
Certaines parties sont publiques `/public` et ne demandent pas d'authentification, alors que d'autres sont privées `/secure` et demandent une authentification (BASIC dans les headers http).
La partie `/normarest` demande également une authentification et est utilisée par l'application Norma
## Informations CDPE Adhesion [/secure/cdpeadhesion/{code}]
+ Parameters
+ code (string) - Code of the CDPE
### Get Infos [GET]
Donne les informations d'un CDPE nécéssaires pour l'adhésion en ligne
+ Response 200 (application/json)
{
"active": true,
"perimetre_id": 69,
"nom": "Rhône",
"site_web": "http://fcpe69.fr/",
"email_contact": "[email protected]",
"paypal": "[email protected]",
"cheque_ordre": "FCPE 69",
"cheque_adresse": {
"adresse":"16 rue Galilée",
"adresse2":"",
"ville":"VILLEURBANNE",
"pays":"FRANCE",
"code_postal":"69100"
},
"virement_iban": "1234-1234-1234-1234-1234-1234-1234",
"niveau_adhesion_web_1": {
"libelle": "Cotisation web niveau 1"
"tarif": 25.5,
},
"niveau_adhesion_web_2": {
"libelle": "Cotisation web niveau 2"
"tarif": 22.5,
},
"abonnement_national": {
"revue_id": 12,
"libelle": "Revue des parents",
"type_abonnement_id": 12,
"tarif": 3.35
},
"abonnements_departementaux": [
{
"revue_id": 13,
"libelle": "Revue dept A",
"type_abonnement_id": 13,
"tarif": 2.00
},
{
"revue_id": 14,
"libelle": "Revue dept B",
"type_abonnement_id": 14,
"tarif": 3.00
}
]
}
+ Response 200 (application/json)
{
"active": false,
"perimetre_id": 73,
"email_contact": "[email protected]",
"paypal": "[email protected]",
"cheque_ordre": "FCPE 73",
"cheque_adresse": "12 avenue Tony Garnier 69007 LYON",
"virement_iban": "1234-1234-1234-1234-1234-1234-1234",
"tarif_adhesion": 25.5,
"tarif_readhesion": 22.5,
"abonnement_national": {
"revue_id": 12,
"libelle": "Revue des parents",
"type_abonnement_id": 12,
"tarif": 3.35
},
"abonnements_departementaux": [
{
"revue_id": 13,
"libelle": "Revue dept A",
"type_abonnement_id": 13,
"tarif": 2.00
},
{
"revue_id": 14,
"libelle": "Revue dept B",
"type_abonnement_id": 14,
"tarif": 3.00
}
]
}
+ Response 404 (application/json)
## Recherche Commune [/public/communes/{search}]
+ Parameters
+ search (string) - Autocomplétion, Recherche commune
### Recherche commune [GET]
Liste les communes qui correspondent au texte recherché (nom ou code postal)
Public : peux être appelé directement depuis le navigateur.
+ Response 200 (application/json)
[
{
"commune_id": 12,
"commune": "LYON 07",
"code_postal": "69007",
"pays": "FRANCE",
},
{
"commune_id": 13,
"commune": "LYON 08",
"code_postal": "69008",
"pays": "FRANCE",
}
]
## Liste Etablissements [/public/etablissements/{commune_id}]
+ Parameters
+ commune_id (number) - identifiant commune
### Liste Etablissements [GET]
Liste les établissements qui correspondent à la commune donnée
Public : peux être appelé directement depuis le navigateur.
+ Response 200 (application/json)
[
{
"cdpe_id": 3,
"perimetre_id": 234,
"etablissement_scolaire_id": 3,
"nom": "ECOLE MA JULES FERRY",
},
{
"cdpe_id": 3,
"perimetre_id": 234,
"etablissement_scolaire_id": 8,
"nom": "ECOLE PR JEAN JAURES",
},
{
"cdpe_id": 3,
"perimetre_id": 234,
"etablissement_scolaire_id": 15,
"nom": "ECOLE PR MARIUS PINARD",
},
{
"cdpe_id": 3,
"perimetre_id": 234,
"etablissement_scolaire_id": 17,
"nom": "LYCÉE AGRICOLE ET VITICOLE",
}
]
## Existance Foyer [/secure/foyers/exist]
### Existance Foyer [POST]
Permet de verifier si un foyer qui va faire une adhesion n'est pas déjà adherent sur le departement
+ Request (application/json)
{
"email": "[email protected]",
"nom": "PRAS",
"prenom": "Sylvain",
"cdpe_id": 69,
"send_lost_password_on_duplicate": true,
}
+ Response 200
{
"exist": true,
}
## Identification Foyer [/secure/foyers/identification]
### Identification Foyer [POST]
Permet d'identifier et de récpérer les informations de l'adhérent
+ Request (application/json)
{
"email": "[email protected]",
"password": "password"
}
+ Response 200
{
"foyer_id": 25,
"cdpe_id": 69,
"cpe_principal_id": 12345,
"adherent_annee_courrante": false,
"code": "069P1600002",
"parent_principal": {
"id": 12,
"nom": "DUPOND",
"prenom": "Jean",
"civilite": "Mr"
},
"adresse" : {
"adresse": "12 avenue tony Garnier",
"commune_id": "1234",
"code_postal": "69007",
"ville": "LYON",
"pays": "FRANCE"
},
"email": "[email protected]",
"telephone_mobile": "0678784565",
"newsletter": true,
"enfants" : [
{
"id": 13,
"nom": "DUPOND",
"prenom": "Pierre",
"date_naissance": "18/09/2010",
"etablissement_scolaire_id": 3,
"etablissement_scolaire_nom" : "Ecole Primaire",
"classe_id": 3,
"classe_libelle": "CP",
"section": "test"
}
],
"responsabilites" : [
{
"responsabilite_perimetre_id" : 12,
"nom" : "Président",
"perimetre_id" : "123",
"code": "0069P20002",
"nom": "CL Lyon 02",
"type_perimetre_id": 3
}
],
"profil" : [
{
"groupe_utilisateur_id" : 12,
"nom" : "Président",
}
],
}
## Demande de changement de mot de passe foyer [/secure/foyers/askforchangepassword]
### Changement mot de passe foyer [POST]
Permet de demander le changement du mot de passe d'un foyer, ce denier envoi un mail avec un jeton de validité
Si l'email n'existe pas dans la base Norma, on répond 404
+ Request (application/json)
{
"email": "[email protected]",
"cdpe": "069",
"referer": "adhesion"
}
+ Response 200
{
}
+ Response 404
## Changement mot de passe foyer [/secure/foyers/changepassword]
### Changement mot de passe foyer [POST]
Permet de demander le changement du mot de passe d'un foyer
+ Request (application/json)
{
"token": "0412ffc5e7e1a19d8d23b4e288b3ced4",
"new_password": "P@ssw0rd!"
}
+ Response 200
## Creation Foyer [/secure/foyers/adhesionenligne]
### Creation Foyer [POST]
Creation ou Edition du foyer en ligne (adhésion et/ou don)
Si c'est une adhesion il ne doit pas y avoir de numéro de foyer,
si c'est une re-adhesion, le numéro de foyer doit être présent et les informations
du foyer modifiées seront mise à jour.
Le paramètre dryn_run permet de faire un appel qui va vérifier les conditions d'adhésion mai ne pas créer l'adhésion, utilisé AVANT le paiement Paypal
+ Request (application/json)
+ Attributes
+ foyer (Foyer)
+ operation: [ADHESION|RE_ADHESION|DON_SEUL] (string)
+ niveau_adhesion: [NIVEAU_WEB1|NIVEAU_WEB2] (string)
+ paiement: [PAYPAL|CHEQUE|VIREMENT] (string)
+ abonnements (array)
+ type_abonnment_id: 12
+ don: 10 (number)
+ transaction_id: TRANSID1234 (string)
+ dry_run: false (boolean)
+ Response 200
{
"message" : "ok",
"code_foyer" : "069P170001"
}
## Workflow validation adhésions en ligne [/normarest/workflow/adhesionenligne]
### Workflow validation adhésions en ligne [POST]
Liste des foyers ayant créé une adhésion en ligne à valider
Le paramètre type_paiement est facultatif, s'il n'est pas specifié tous les types de paiements seront retournés
Le paramètre inclus_en_attente est facultatif, s'il n'est pas specifié les paiements en attente seront retournés
+ Request (application/json)
{
"cdpe_id": 69,
"types_paiement": ["CHEQUE","VIREMENT","PAYPAL"],
"inclus_en_attente" : true
}
+ Response 200
[
{
"foyer_id" : 1234,
"code" : "069P170001",
"cpe_principal_id": 234,
"parent_principal": {
"id": 12,
"nom": "DUPOND",
"prenom": "Jean",
"civilite": "Mr"
},
"email" : "[email protected]",
"montant_adhesion_national": 6,
"montant_adhesion_departemental": 10,
"montant_abonnement": 0,
"montant_don": 0,
"conseils_locaux_etablissements_enfants": [
{
"perimetre_id": 234,
"code": "069O0001",
"nom": "CL Lyon 01"
},
{
"perimetre_id": 235,
"code": "069O0002",
"nom": "CL Lyon 02"
}
],
"type_paiement": "PAYPAL"
},
{
"foyer_id" : 1235,
"code" : "069P170002",
"cpe_principal_id": 235,
"parent_principal": {
"id": 13,
"nom": "DUPONT",
"prenom": "Jean",
"civilite": "Mr"
},
"email" : "[email protected]",
"montant_adhesion_national": 6,
"montant_adhesion_departemental": 10,
"montant_abonnement": 3.35,
"montant_don": 10.45,
"conseils_locaux_etablissements_enfants": [
{
"perimetre_id": 234,
"code": "069O0001",
"nom": "CL Lyon 01"
},
{
"perimetre_id": 235,
"code": "069O0002",
"nom": "CL Lyon 02"
},
{
"perimetre_id": 236,
"code": "069O0003",
"nom": "CL Lyon 03"
}
],
"type_paiement": "PAYPAL"
}
]
## Liste des conseils départementaux [/normarest/perimetre/cdpelist]
### Liste des conseils départementaux [GET]
Liste des conseils départementaux
+ Response 200
[
{
"perimetre" : 2,
"code" : "001",
"nom": "Ain"
},
{
"perimetre_id" : 3,
"code" : "002",
"nom": "Aisne"
},
{
"perimetre_id" : 4,
"code" : "003",
"nom": "Allier"
},
{
"perimetre_id" : 38,
"code" : "038",
"nom": "Isère"
},
{
"perimetre_id" : 69,
"code" : "069",
"nom": "Rhône"
}
]
## Liste des conseils locaux [/normarest/perimetre/{cdpe_id}/cpelist]
### Liste des conseils locaux [GET]
Liste des conseils locaux d'un CDPE
/!\ Attention, cette API n'est plus à implémenter !
+ Parameters
+ cdpe_id (number) - identifiant cdpe (perimetre departemental)
+ Response 200
[
{
"perimtere_id" : 1234,
"code" : "06900001",
"nom": "CL VILLEURBANNE",
},
{
"perimtere_id" : 1235,
"code" : "06900002",
"nom": "CL LYON 02",
}
]
## Mise à jour du conseil local du foyer [/normarest/foyer/changecpe]
### Mise à jour du conseil local du foyer [POST]
Change le conseil local du foyer
+ Request (application/json)
{
"foyer_id": 12345,
"cpe_principal_id": 123
}
+ Response 200
{
"message" : "ok"
}
+ Response 400
{
"message" : "Il est impossible de mettre ce CL sur ce foyer"
}
## Mise en attente de paiement du/des foyers [/normarest/workflow/adhesionenligne/attentepaiement]
### Mise en attente de paiement du/des foyers [POST]
Change le type de paiement du/des foyers pour les passer en attente de paiement
+ Request (application/json)
{
"foyers": [123,124,134]
}
+ Response 200
{
"message" : "ok"
}
+ Response 400
{
"message" : "message d'erreur"
}
## Validation adhésion en ligne [/normarest/workflow/adhesionenligne/validation]
### Validation adhésion en ligne [POST]
Valide l'adhésion en ligne du/des foyers, le statut du foyer change et il "rentre" dans le workflow de validation classique.
+ Request (application/json)
{
"foyers": [123,124,134]
}
+ Response 200
{
"message" : "ok"
}
+ Response 400
{
"message" : "message d'erreur"
}
## Utilisateur connecté [/normarest/utilisateur_connecte]
### Utilisateur connecté [GET]
Informations sur l'utilisateur connecté, notament la liste de droits d'accès associés.
+ Response 200
{
"utilisateur_id" : 1234,
"nom": "DI MERCURIO",
"prenom": "Guy",
"login": "guy69",
"email": "[email protected]",
"perimetre" : {
"perimetre_id" : 12,
"code" : "012",
"type_perimetre_id" : 2
},
"droits": [ 12, 23, 34, 45]
}
## Liste utilisateurs d'un département [/secure/perimetre/{perimetre_id}/utilisateurs]
+ Parameters
+ perimetre_id (int) - ID of the CDPE Permietre
### Liste utilisateurs d'un département [GET]
Liste des utilisateurs d'un département
+ Response 200
{
"perimetre_id" : 2,
"code" : "001",
"nom": "Ain"
"utilisateurs": [
{
"utilisateur_id" : 1234,
"foyer_id": 0,
"foyer_code": "",
"nom": "DI MERCURIO",
"prenom": "Guy",
"email": "[email protected]",
"responsabilites": [],
"profil" : [
{
"groupe_utilisateur_id" : 12,
"nom" : "ADMINISTRATIF",
},
{
"groupe_utilisateur_id" : 13,
"nom" : "SIEGE",
}
]
},
{
"utilisateur_id" : 1235,
"foyer_id": 13,
"foyer_code": "001P0000121",
"nom": "DI MERCURIO",
"prenom": "Guy",
"email": "[email protected]",
"responsabilites": [
{
"responsabilite_perimetre_id" : 12,
"nom" : "Président",
}
],
"profil" : [
{
"groupe_utilisateur_id" : 12,
"nom" : "ADMINISTRATIF",
},
{
"groupe_utilisateur_id" : 13,
"nom" : "SIEGE",
}
]
}
]
}
# Data Structures
## Foyer (object)
+ foyer_id: 25 (number) - Identifiant
+ cdpe_id: 69 (number) - Id perimetre du département (voir /secure/cdpeadhesion/{code})
+ cpe_principal_id: 12345 (number) - id perimetre local principal du foyer (connu seulement en réadhésion)
+ adherent_annee_courrante: false (boolean) - true seulement dans le cas de l'identification si le foyer a déjà une adhésion sur l'année en cours.
+ code: 069P1600002 (string) - Code foyer unique
+ parent_principal (Personne)
+ adresse (Adresse)
+ email: [email protected] (string)
+ telephone_mobile: 0678784565 (string)
+ newsletter: true (boolean)
+ enfants (array[Enfant])
+ responsabilites (array[Responsabilite])
## Personne (object)
+ id: 12 (number)
+ nom: DUPOND (string)
+ prenom: Jean (string)
+ civilite: Mr (string)
## Adresse (object)
+ adresse: 12 avenue tony Garnier (string)
+ commune_id: 1234 (number)
+ code_postal: 69007 (string)
+ ville: LYON (string)
+ pays: FRANCE (string)
## Enfant (object)
+ id: 13 (number)
+ nom: DUPOND (string)
+ prenom: Pierre (string)
+ date_naissance: 18/09/2010 (string)
+ etablissement_scolaire_id: 3 (number)
+ etablissement_scolaire_nom : Ecole Primaire Paul Langevin (string)
+ classe_id: 3 (number)
+ classe_libelle: CP (string)
+ section: test (string)
## Responsabilite (object)
+ responsabilite_perimetre_id: 12 (number)
+ nom: Président (string)
+ perimetre (Perimetre)
## Perimetre (object)
+ perimetre_id: 123 (number)
+ code: 0069P20002 (string)
+ nom: CL Lyon 02 (string)
+ type_perimetre_id: 3 (number)