Skip to content
This repository has been archived by the owner on Oct 15, 2019. It is now read-only.

API Files

M. Fazel Soltani edited this page Oct 10, 2019 · 7 revisions

API Documentation

This article documentates the Files API.

This API is designed for use in Clouddrop context. TODO!!!

Services:

  1. Register
  2. Login
  3. Logout
  4. Authenticate a token
  5. Get a single user
  6. Update user data
  7. Delete a user

Register

REQUEST

  • POST /user
+ HEADER
Headername Value
type application/xml
+ BODY
<?xml version="1.0" encoding="UTF-8"?>
<user>
	<name>Some Name</name>
	<email>some@address.com</email>
	<password>*******</password>
	<role>user</role>
</user>

RESPONSE

+ HEADER
Headername Value
Statuscode 204
+ BODY

Login

REQUEST

  • GET /user/login
+ HEADER
Headername Value
Auth "Basic " + encodedBase64(Email:Password)
+ BODY

RESPONSE

+ HEADER
Headername Value
Statuscode 204
client-token xyz
+ BODY

Logout

REQUEST

  • GET /user/logout
+ HEADER
Headername Value
client-token xyz
+ BODY

RESPONSE

+ HEADER
Headername Value
Statuscode 204
+ BODY

Authenticate a token

REQUEST

  • GET /user/auth
+ HEADER
Headername Value
client-token xyz
+ BODY

RESPONSE

+ HEADER
Headername Value
Statuscode 200
type application/xml
+ BODY
<?xml version="1.0" encoding="UTF-8"?>
<auth>
	<client-token>xyz</client-token>
	<email>some@address.com</email>
	<role>user</role>
</auth>

Get user

REQUEST

  • GET /user/{email}
+ HEADER
Headername Value
client-token xyz
+ BODY

RESPONSE

+ HEADER
Headername Value
Statuscode 200
type application/xml
+ BODY
<?xml version="1.0" encoding="UTF-8"?>
<user>
	<name>Some Name</name>
	<email>some@address.com</email>
	<password>*******</password>
	<role>user</role>
</user>

Update user

REQUEST

  • PUT /user/{email}
+ HEADER
Headername Value
client-token xyz
type application/xml
+ BODY
<?xml version="1.0" encoding="UTF-8"?>
<user>
	<name>New Name</name>
	<email>some@address.com</email>
	<password>*******</password>
</user>

RESPONSE

+ HEADER
Headername Value
Statuscode 204
+ BODY

Delete user

REQUEST

  • DELETE user/{email}
+ HEADER
Headername Value
client-token xyz
+ BODY

RESPONSE

+ HEADER
Headername Value
Statuscode 204
+ BODY

Clone this wiki locally