Summary

• Page properties (3 modified, 0 added, 0 removed)

Details

Page properties

Title

...	...	@@ -1,0 +1,1 @@
	1	+Authentification endpoints

Parent

...	...	@@ -1,0 +1,1 @@
	1	+Documentation.iXPath.User Guide.API endpoints.WebHome

Content

...	...	@@ -1,0 +1,40 @@
	1	+= Introduction =
	2	+
	3	+This documentation describes how to get authenticated to the iXPath App.
	4	+
	5	+= Endpoints =
	6	+
	7	+|(% style="width:230px" %)**URL [method]**|(% style="width:379px" %)**Description**|(% style="width:279px" %)**Input example**|(% style="width:472px" %)**Output example**
	8	+|(% style="width:230px" %)/auth [POST]|(% style="width:379px" %)generate a token to get access to all other endpoints.|(% style="width:279px" %)(((
	9	+The input data are "login" and "password", and they must be placed in the **//__header__ //**of the request as the following example :
	10	+
	11	+* __login__: user4r
	12	+* __password__: abcdef
	13	+
	14	+[[image:2021-11-17_16h10_57.png]]
	15	+)))|(% style="width:472px" %){{code language="JSON" layout="LINENUMBERS"}}{
	16	+ "timestamp": 1637162043978,
	17	+ "status": "200",
	18	+ "data": {
	19	+ "Token": "eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJhZG1pbiIsI
	20	+mlkIjoiMSIsImVudiI6ImlYUGF0aCIsInRpbWUiOjE2Njg2OTgwNDM
	21	+0OTN9.0aiAL7BHTanzm1yrELOOaHonWOqPddaUu26lL1GpAJJ6MPxK9eUta
	22	+RAi2m_gV8OhcYhPE_wgu8lESxMevT90YA",
	23	+ "Expiration_date": "2022/11/17 16:14:03",
	24	+ "Default_env": "iXPath"
	25	+ }
	26	+}{{/code}}
	27	+
	28	+
	29	+= Possible errors or exceptions =
	30	+
	31	+* If information is not filled in correctly or the user doesn't exist, the response will look like this example :
	32	+
	33	+{{code language="JSON" layout="LINENUMBERS"}}
	34	+{
	35	+ "timestamp": 1637164878357,
	36	+ "status": "500",
	37	+ "error": "the user's information not found : user, password",
	38	+ "thechnicalError": "the user's information not found : user, password"
	39	+}
	40	+{{/code}}