Manuel d`utilisation API Pastell
Contents
1. Nom journal php Description R cup re tout ou partie du journal des v nements Tout les param tres sont optionnels Entr es id_e Identifiant num rique de l entit id_d Identifiant unique du document id_user Identifiant de l utilisateur type Type de document retourn par document type php format Format du journal json ou bien csv offset num ro de la premi re ligne retourner limit Nombre maximum de lignes retourner date_debut Date partir de laquelle les informations sont r cup r es date_fin Date au del de laquelle les informations ne sont plus r cup r es Sorties id_j Num ro unique auto incr mentiel et sans trou du journal type 1 Action sur un document 2 Notification 3 Modification d une entit 4 Modification d un utilisateur 5 Mail s curis 6 Connexion 7 Consultation d un document id_e Identifiant de l entit id_u Identifiant de l utilisateur id_d Identifiant du document action Action effectu e message Message date Date de l ajout dans le journal peut tre diff rents de l horodatage preuve Contenu de la preuve Peut tre utilis dans une application qui sait analyser les jetons d horodatage date_horodatage Date r cup r dans le jeton d horodatage message_horodate Message qui a t horodat titre Titre du document document_type Type du document denomination Nom de l entit nom Nom de l utilisateur prenom Pr nom de l utilisateur API Pastell Page 10 11 ADULLA2. erreur la sortie est la suivante status Status de la sortie de la fonction error error message Message d erreur 4 Version de la plateforme Nom version php Description Permet d obtenir la version de la plateforme Pastell assure une compatibilit ascendante entre les diff rents num ro de r vision ie Un script bas sur une r vision n fonctionneras avec une r vision n 1 de Pastell Entr es aucune Sorties version Num ro de version commerciale revision Num ro de r vision du d p t de source officiel de Pastell ttps adullact net scm viewvc php root pastell version complete Version affich sur la l interface web de la plateforme 5 Types de documents propos s par la plateforme Nom document type php Description Liste l ensemble des flux types de documents disponible sur Pastell comme par exemple les actes les mails s curis es les flux citoyen etc Entr es aucune Sorties nom symbolique du type type Groupe de type de document de document exemple Flux g n raux Exemple actes mail Lu nom Nom afficher pour l utilisateur exemple ae Actes Message du centre de gestion 6 Description d un type de document Nom document type info php Description Liste l ensemble des champs d un type document ainsi que les informations sur chaque champs type de champs valeur par d faut script de choix
3. rique de l entit id_d Liste d identifiant unique de document Sorties info Reprend les informations disponible sur list document php data Donn es issue du formulaire voir document type info php pour savoir ce qu il est possible de r cup rer action_possible Liste des actions possible exemple modification envoie tdt 11 Cr ation d un nouveau document Nom create document php Description Cr e un nouveau document Entr es id_e Identifiant num rique de l entit type Type de document API Pastell Page 7 11 ADULLACT API a ar Sorties id d Identifiant unique du document cr e noter que cette fonction de cr ation d un nouveau document PASTELL cr e toujours un objet vide Il conviendra une fois cr de modifier ce document l aide de la fonction suivante modif document php 12 Modification d un document Nom modif document php Description Modifie les champs d un document Entr es id e Identifiant num rique de l entit type Type de document champs Valeur du champs Il est possible d attacher un fichier ce champs via un Nom du champs tel POST que donn par le type de document exemple nature acte Sorties result ok si l enregistrement s est bien d roul noter que pour conna tre la liste et les intitul s exacts des champs mofifiables il convient d utiliser la
4. ADULLACT_ Projet Manuel d utilisation API Pastell Rev 31 API Pastell Page 1 11 ADULLACT_ iy a Tar volution du document Version Nature des changements Date 1 0 Cr ation du document Eric Pommateau Sigmalis 14 01 2012 1 1 Mise jour du document Pascal Kuczynski ADULLACT 20 01 2012 1 2 Mise jour du document Eric Pommateau Sigmalis 05 05 2012 1 3 Mise jour du document Eric Pommateau Sigmalis 21 05 2012 Approbation Auteur Chef de projet Directeur Technique Nom SIGMALIS Nom Pascal Kuczynski Nom Pascal Kuczynski Date 14 01 2012 Date 20 01 2012 Date 20 01 2012 Contacts ADULLACT contact adullact org API Pastell Page 2 11 ADULLACT_ Pre yar x Table des mati res J N e Sec a en les 4 2 ASRUTICAUONS Ne need online 4 3 Utilisation d L APL Ses ensnntete unissent ind ea attenant 4 4 Version de la plateforme sees retenir einr te 5 5 Types de documents propos s par la plateforme RRRRRRR 5 6 Description d un type de documents sss sese eee eee 5 729 LISTE T 6 8 Liste des document d une entit ne ee een 6 9 D tail vesae 2727214251 E 7 10 D tail d plusieurs documents us iniiis aiaiai niii 7 11 Cr ation d un nouveau documents sese sees ee sese eee 7 12 Modification d un document sss sss sese sese 8 13 R cup ration des valeur
5. API Pastell Page 5 11 ADULLACT API a re numero de lacte Entr es type Type de document tel que donn es comme cl dans le r sultat de document type php Exemple actes mailsec Sorties nom du champs n propri t Exemple acte nature Propri t s du champs exemple Valeur de la lib ll lib ll afficher propri t l utilisateur ex Nature de read only le champ n est pas l actes modifiable La description de l ensemble des propri t s est disponible dans le manuel d utilisation 7 Liste des entit s Nom list entite php Description Liste l ensemble des entit s sur lesquelles l utilisateur a des droits Liste galement les entit s filles Entr es aucune Sorties id e Identifiant num rique de l entit denomination Libell de l entit ex Saint Amand les Eaux siren Num ro SIREN de l entit si c est une collectivit ou un centre de gestion centre de gestion Identifiant num rique du CDG de la collectivit entite mere Identifiant num rique de l entit m re de l entit par exemple pour un service 8 Liste des document d une entit Nom list document php Description Liste l ensemble des documents d une entit Liste galement les entit s filles Entr es id e Identifiant num rique de l entit type Type de document offset faculta
6. CT Pre re 16 R cup rer un fichier Nom recuperation fichier php Description R cup re un fichier attach un document Entr es id e Identifiant num rique de l entit id d Identifiant unique du document field Nom du champ a r cup rer num Le num ro du fichier s il y en a plusieurs Sorties Le fichier 17 Exemple PHP Voici un exemple tr s simple en PHP utilisant l authentification HTTP par login mot de passe Cet exemple permet de r cup rer la liste des entit s de la plateforme lt php login coll Spassword coll url http pastell test adullact org Exemple de code pour r cup rer la liste des collectivit s disponibles pour l utilisateur authentifi curl curl init curl setopt curl CURLOPT HTTPAUTH CURLAUTH BASIC curl setopt curl CURLOPT USERPWD login password curl setopt curl CURLOPT RETURNTRANSFER true curl setopt curl CURLOPT URL url web api list entite php result curl exec curl curl close curl entities json_decode result 77 On r cup re ainsi la liste des id de collectivit s id e n cessaires pour d poser des documents 2 gt API Pastell Page 11 11
7. fonction document type info php en lui pr cisant le type concern Exemple pour le type actes https monpastell monsite fr web api document type info php type actes 13 R cup ration des valeurs possibles d un champ Nom external data php Description R cup re les valeurs possible d un champs En effet certaine valeur sont externe a Pastell classification Actes classification CDG etc Ce script permet de r cup rer l ensemble de ces valeurs Ce script est utilisable sur tous les champs qui dispose d une propri t s controler Entr es id e Identifiant num rique de l entit id d Identifiant unique du document field Nom du champs Sorties valeur Information suppl mentaire sur la valeur possible ventuellement sous possible forme de tableau associatif 14 Ex cution d une action Nom action php Description Execute une action sur un document API Pastell Page 8 11 ADULLACT Pre re x Entr es id e Identifiant num rique de l entit id d Identifiant unique du document action Nom de l action r cup r dans la sortie du d tail document dans le champs action possible Sorties result 1 si l action a t correctement ex cute Sinon une erreur est envoy API Pastell Page 9 11 ADULLACT Praa re Z 15 Journal des v nements
8. isateurs de la plateforme alors il doit en plus utilis un login mot de passe Si un login mot de passe est n cessaire celui ci doit tre envoy via l authentification HTTP 3 Utilisation de l API L API Pastell est compos d un certain nombre de script qui sont pr senter dans la suite du document Chaque script est document de la mani re suivante Nom nom du script qui doit tre appel Description description du service et de son utilisation Entr es Liste des param tres d entr es qui doivent tre pass via les m thodes HTTP GET ou POST Si un fichier doit tre envoy sur la plateforme alors seul la m thode POST est utilisable Sorties Description du document JSON de sortie Un document JSON est une repr sentation textuelle d un tableau associatif Sortie Nous utilisons les conventions suivantes pour d crire les cl s et valeurs de ce tableau Les cl s fixes sont crites en police monospace Les cl s variables sont crites en police monospace entour de guillemet API Pastell Page 4 11 ADULLACT API aD re Z l int rieur du guillemet contenant une description de la cl Le contenu des valeurs sont crites en police standards Une toile la fin d une cl indique que la cl variable peut tre utilis e plusieurs fois Toutes les dates de sorties sont au format Y Y Y Y mm dd HH mm ss exemple 2012 01 31 16 30 45 Pour tout les scripts en cas d
9. s possibles d un Champ 8 T4 Ex cution Tele 8 15 Journal d s Vv nements c nn need teen nd 10 16 R cup rer un TC IGP Reel au dites 11 LA Exemple PAP eee ne A 11 API Pastell Page 3 11 ADULLACT Pre ee 1 Principes g n raux Pastell est utilisable via une API qui propose les m me fonctionnalit s que l interface web classique L API est bas sur des web service de type REST Pastell ne propose pas de web service SOAP Les op rations sont donc r alis es uniquement avec des requ tes HTTP GET ou POST La sortie des fonctions de l API sont uniquement propos en JSON Si URL de base de la plateforme est https pastell sigmalis com alors tout les scripts doivent tre appel via https pastell sigmalis com api nom du script php 2 Authentification Afin d utiliser l API il est n cessaire de d avoir cr un utilisateur Pastell La cr ation d un utilisateur ainsi que le mod le de droit est d fini dans le Manuel utilisateur de Pastell Pastell a besoin que l utilisateur s authentifie Cela est fait soit e par certificat num rique e par login mot de passe e avec les deux La pr sentation du certificat ou du couple login mot de passe suit les m mes principes que l authentification de l utilisateur sur le site web e si le champ certificat est renseign pour l utilisateur alors il doit le pr senter sinon le login mot de passe suffisent e si un certificat est utilis par deux util
10. tif num ro de la premi re ligne retourner limit facultatif 100 par d faut nombre de document retourn Sorties id e Identifiant num rique de l entit identique l entr e id d Identifiant unique du document role R le de l entit sur le document exemple diteur API Pastell Page 6 11 ADULLACT Pro jar 4 last_action Derni re action effectu e sur le document last_action date Date de la derni re action Type Type de document identique l entr e Creation Date de cr ation du document Modification Date de derni re modification du document entite Liste des identifiant id_e des autres entit s qui ont des droits sur ce document 9 D tail d un document Nom detail document php Description R cup re l ensemble des informations sur un document Liste galement les entit s filles Entr es id_e Identifiant num rique de l entit id d Identifiant unique du document Sorties info Reprend les informations disponible sur list document php data Donn es issue du formulaire voir document type info php pour savoir ce qu il est possible de r cup rer action_possible Liste des actions possible exemple modification envoie tdt 10 D tail de plusieurs documents Nom detail several document php Description R cup re l ensemble des informations sur plusieurs documents Entr es id_e Identifiant num
Download Pdf Manuals
Related Search