$connect (sdata)

De Wiki1000
(Différences entre les versions)
(→Paramètres)
m (a déplacé Connect (sdata) vers $connect (sdata))
 
(16 révisions intermédiaires par 2 utilisateurs sont masquées)
Ligne 1 : Ligne 1 :
−
{{latest}}
+
{{Version700}}
  
 
Le service SData supporte une fonction système pour ouvrir une session ou obtenir des information à propos de la session ouverte.
 
Le service SData supporte une fonction système pour ouvrir une session ou obtenir des information à propos de la session ouverte.
Ligne 22 : Ligne 22 :
 
|-
 
|-
 
|POST
 
|POST
−
|Dans le payload, format form-encoded
+
|Dans le payload, [http://www.w3.org/TR/html401/interact/forms.html#h-17.13.4.1 format form-encoded ]
 
|}
 
|}
  
Ligne 35 : Ligne 35 :
 
!Usage
 
!Usage
 
|-
 
|-
−
|user
+
|username
 
|Identifiant de l'utilisateur
 
|Identifiant de l'utilisateur
 
|-
 
|-
Ligne 41 : Ligne 41 :
 
|Mot de passe de l'utilisateur
 
|Mot de passe de l'utilisateur
 
|-
 
|-
−
|folder
+
|groupName
 +
|Autorisé en tant que membre de ce groupe
 +
|-
 +
|authdirectory
 +
|Annuaire d'identité
 +
|-
 +
|md5
 +
|Hash md5 du mot de passe
 +
|-
 +
|society
 
|Dossier où ouvrir une session
 
|Dossier où ouvrir une session
−
}
+
|}
  
−
{{tip|Le paramètre folder est optionnel si le Service sert un seul dossier.}}
+
{{tip|Le paramètre '''society''' est optionnel si le Service sert un seul dossier.}}
  
 
Pour un dossier multi-sociétés les paramètres suivants sont optionnels :
 
Pour un dossier multi-sociétés les paramètres suivants sont optionnels :
Ligne 54 : Ligne 63 :
 
!Usage
 
!Usage
 
|-
 
|-
−
|society
+
|shareSociety
 
|Société de travail du dossier si le dossier est multi-sociétés
 
|Société de travail du dossier si le dossier est multi-sociétés
 
|-
 
|-
−
|societies
+
|shareSocieties
 
|Sociétés de restitution du dosser si le dossier est multi-sociétés
 
|Sociétés de restitution du dosser si le dossier est multi-sociétés
 
|}
 
|}
Ligne 84 : Ligne 93 :
 
Lorsque la la requête retourne 200 le contenu contient des informations sur la configuration de la session.
 
Lorsque la la requête retourne 200 le contenu contient des informations sur la configuration de la session.
  
−
Le format de la réponse dépend de la valeur du paramètre ''Accept'' de l'entête de la requête, les formats supportées sont json,text,xml.  
+
Le format de la réponse dépend de la valeur du paramètre ''Accept'' de l'entête de la requête, les formats supportés sont json,text,xml.  
  
 
Les paramètres retournés sont :
 
Les paramètres retournés sont :
  
−
{|class="wikitable"
+
{{:Informations de session (server)}}
−
|-
+
−
!Paramètre
+
−
!Usage
+
−
|-
+
−
|user
+
−
|Nom de l'utilisateur de l'utilisateur.
+
−
|-
+
−
|userLanguage
+
−
|Langue de l'utilisateur.
+
−
|-
+
−
|userName
+
−
|Intitulé de l'utilisateur.
+
−
|-
+
−
|asMember
+
−
|Autorisé en tant que membre du groupe.
+
−
|-
+
−
|folder
+
−
|Dossier de la session.
+
−
|-
+
−
|application
+
−
|Nom de l'application de la session
+
−
}
+
  
−
Si le dossier est multi-société les informations suivantes sont retournées :
 
  
−
{|class="wikitable"
+
exemple
−
|-
+
<pre>
−
!Paramètre
+
POST /sdata/$connect HTTP/1.1
−
!Usage
+
Content-Type: application/x-www-form-urlencoded
−
|-
+
Host: localhost
−
|society
+
Content-Length: 13
−
|Société de travail de la session.
+
−
|-
+
username=sage&password=pwd
−
|societies
+
</pre>
−
|Sociétés de restitution du dossier si le contexte de partage est en mode restitution.
+
 
−
|-
+
<pre>
−
|readSocieties
+
https://pc100301/sdata/$connect
−
|Sociétés sur lesquelles l'utilisateur à un droit de lecture.
+
OK
−
|-
+
{
−
|writeSocieties
+
  "methodResponse":{
−
|Sociétés sur lesquelles l'utilisateur à un droit de modification.
+
      "params":{
−
|}
+
        "username":"syfre",
 +
        "userfullname":"....",
 +
        "userlanguage":"FRA",
 +
        "useremail":".[email protected]",
 +
        "groupname":"Projet 1000",
 +
        "groupcaption":"Groupe Projet 1000",
 +
        "authdirname":"enterprise",
 +
        "socname":"8.00 - Suite Multi",
 +
        "appname":"Sage FRP 1000 Suite Financière",
 +
        "glbShareEnable":"true",
 +
        "glbShareRestitution":"false",
 +
        "glbShareAllPerimeters":"false",
 +
        "glbShareRestitutionName":"",
 +
        "glbShareSocieties":"AC2B84B4153A03FE07220000024D0048",
 +
        "glbSharePerimeters":"AC2B84B4153A03FE06A1000002370002,....,AC2B84B4153A03FE07220000024C0004",
 +
        "glbShareGroupMode":"false",
 +
        "glbShareGroupPerimeter":"AC2B84B4153A03FE06A1000002370002",
 +
        "glbShareSocietyPerimeter":"AC2B84B4153A03FE07220000024D0048",
 +
        "GlbShareSocietyName":"S2",
 +
        "GlbSharePerimeterNames":"Dossier,S2,P2 Services,T2 Tiers categorie 2",
 +
        "GlbShareSocietyNames":"S2",
 +
        "GlbShareAutorized":{
 +
            "society":[
 +
              {
 +
                  "title":"S2",
 +
                  "oid":"AC2B84B4153A03FE07220000024D0048"
 +
              }
 +
            ]
 +
        },
 +
        "ShareState":"AC2B84B4153A03FE06A1000002370002.....................",
 +
        "ShareSociety":"AC2B84B4153A03FE07220000024D0048",
 +
        "ShareSocietyName":"S2",
 +
        "ShareRestitution":"false",
 +
        "ShareAllPerimeters":"false",
 +
        "ShareStateCaption":"S2",
 +
        "database":"CF_db800SuiteMonobaseMultisoc",
 +
        "databases":[
 +
            "CF_db800SuiteMonobaseMultisoc"
 +
        ],
 +
        "GA":{
 +
            "dialogUrl":"https://eme.sage.fr/pep/home.html",
 +
            "enable":false,
 +
            "ua":""
 +
        },
 +
        "menu":{
 +
            "id":"",
 +
            "caption":""
 +
        }
 +
      }
 +
  }
 +
}</pre>
 +
 
 +
Voir aussi:
  
 
[[Category:SData]]
 
[[Category:SData]]
−
[[Category:Latest]]
+
[[Category:$SData]]
 +
[[Category:Mobile]]
 +
[[Category:Version700]]

Version actuelle en date du 17 août 2017 à 09:42

version700-32x32.png

Le service SData supporte une fonction système pour ouvrir une session ou obtenir des information à propos de la session ouverte.

L'url de cette fonction est : 

http://www.example.com/service/server/sdata/$connect

Pour un service utilisant le serveur HTTP intégré l'URL peut être simplifiée : 

http://www.example.com/sdata/$connect

Les requêtes de méthode GET/HEAD/POST sont autorisées.

Méthode Paramètres
GET/HEAD Dans l'URL
POST Dans le payload, format form-encoded

Lorsque un identifiant de session est passé en paramètre la session correspondante est contrôlée, si elle est valide cette session est réutilisée et la requête n'alloue pas de nouvelle session. La configuration de la session peut être ensuite modifiée suivant les paramètres de la requête.

Paramètres

Les paramètres supportés sont :

Paramètre Usage
username Identifiant de l'utilisateur
password Mot de passe de l'utilisateur
groupName Autorisé en tant que membre de ce groupe
authdirectory Annuaire d'identité
md5 Hash md5 du mot de passe
society Dossier où ouvrir une session
Tip-20px.png Tip : Le paramètre society est optionnel si le Service sert un seul dossier.

Pour un dossier multi-sociétés les paramètres suivants sont optionnels :

Paramètre Usage
shareSociety Société de travail du dossier si le dossier est multi-sociétés
shareSocieties Sociétés de restitution du dosser si le dossier est multi-sociétés

Code de retour

Code Contenu Usage
200 Information de session La session est connectée
403 Forbidden Les informations d'authentification ne sont pas valident
404 Dépend de la raison La session est connecté mais les informations de configuration du contexte ne sont pas valident.

Contenu

Lorsque la la requête retourne 200 le contenu contient des informations sur la configuration de la session.

Le format de la réponse dépend de la valeur du paramètre Accept de l'entête de la requête, les formats supportés sont json,text,xml.

Les paramètres retournés sont :

Informations sur le dossier

Paramètre Usage
socname Dossier de la session.
appname Nom de l'application de la session
glbShareEnable Le contexte est en mode partage

Informations sur l'utilisateur

Paramètre Usage
username Nom de l'utilisateur.
userfullname Nom complet de l'utilisateur.
userlanguage Langue de l'utilisateur.
useremail Email de l'utilisateur.
groupname Autorisé en tant que membre du groupe.
authdirname Intitulé de l'annuaire utilisé.

Si le dossier est multi-société les informations suivantes sont retournées :

Vue contexte :

Paramètre Usage
glbShareRestitution Le contexte est mode restitution
glbShareAllPerimeters Le contexte est en mode restitution sur toutes les sociétés
glbShareSocieties Liste des sociétés du contexte de restitution
glbShareGroupMode Le contexte est en mode groupe
glbShareGroupPerimeter Périmètre groupe du contexte.
glbShareSocietyPerimeter Périmètre sociétés du contexte
glbSharePerimeters Périmètres actifs du contexte
glbShareSocietyName Nom de la société du contexte
glbSharePerimeterNames Nom de tous les périmètres actifs du contexte
glbShareSocietyNames Nom de toutes les sociétés du dossier
GlbShareAutorizedReadSocieties Nom des sociétés sur lesquelles l'utilisateur à des droits de lecture
GlbShareAutorizedWriteSocieties Nom des sociétés sur lesquelles l'utilisateur à des droits d'écriture

Vue API :

Information Type Valeur
ShareState string Une chaîne contenant la sérialisation de l'état du contexte de partage.
ShareSociety OID Le périmètre de la société active
ShareSocietyName string le nom de la société active.
ShareRestitution boolean Le contexte est en mode restitution.
ShareAllPerimeters boolean Le mode restitution est sur toutes les sociétés du dossier.
ShareRestitutionSocieties StringList Liste des noms de toutes les périmètres des sociétés actives


exemple 

POST /sdata/$connect HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Host: localhost
Content-Length: 13
 
username=sage&password=pwd

https://pc100301/sdata/$connect
OK
{
   "methodResponse":{
      "params":{
         "username":"syfre",
         "userfullname":"....",
         "userlanguage":"FRA",
         "useremail":"[email protected]",
         "groupname":"Projet 1000",
         "groupcaption":"Groupe Projet 1000",
         "authdirname":"enterprise",
         "socname":"8.00 - Suite Multi",
         "appname":"Sage FRP 1000 Suite Financière",
         "glbShareEnable":"true",
         "glbShareRestitution":"false",
         "glbShareAllPerimeters":"false",
         "glbShareRestitutionName":"",
         "glbShareSocieties":"AC2B84B4153A03FE07220000024D0048",
         "glbSharePerimeters":"AC2B84B4153A03FE06A1000002370002,....,AC2B84B4153A03FE07220000024C0004",
         "glbShareGroupMode":"false",
         "glbShareGroupPerimeter":"AC2B84B4153A03FE06A1000002370002",
         "glbShareSocietyPerimeter":"AC2B84B4153A03FE07220000024D0048",
         "GlbShareSocietyName":"S2",
         "GlbSharePerimeterNames":"Dossier,S2,P2 Services,T2 Tiers categorie 2",
         "GlbShareSocietyNames":"S2",
         "GlbShareAutorized":{
            "society":[
               {
                  "title":"S2",
                  "oid":"AC2B84B4153A03FE07220000024D0048"
               }
            ]
         },
         "ShareState":"AC2B84B4153A03FE06A1000002370002.....................",
         "ShareSociety":"AC2B84B4153A03FE07220000024D0048",
         "ShareSocietyName":"S2",
         "ShareRestitution":"false",
         "ShareAllPerimeters":"false",
         "ShareStateCaption":"S2",
         "database":"CF_db800SuiteMonobaseMultisoc",
         "databases":[
            "CF_db800SuiteMonobaseMultisoc"
         ],
         "GA":{
            "dialogUrl":"https://eme.sage.fr/pep/home.html",
            "enable":false,
            "ua":""
         },
         "menu":{
            "id":"",
            "caption":""
         }
      }
   }
}

Voir aussi:

Récupérée de « https://frp.sage.fr/wiki1000/index.php?title=$connect_(sdata)&oldid=11625 »
Outils personnels