Smart University of Napoli Parthenope RESTful API Store

License/Key

LGPL/no

Author

Raffaele Montella

Description

The API Store is...

How to cite this API:

University of Napoli Parthenope, http://api.uniparthenope.it, 2013

Base URI

https://api.uniparthenope.it/


1. Get the API icon

Description:

Return the API icon. Applicable to all hosted APIs as /apiname/icon.

URI

https://api.uniparthenope.it/icon

URI Parameters

HTTP Method

GET

Resource Formats

image/png

Authentication

Responses

200 OK OK
201-Created-No content
231-custom-Info not avaiable
400-Bad Request-Bad Request
401-Not found-Not found


2. Get the API manifest

Description:

Return the API manifest. Applicable to all hosted APIs as /apiname/manifest

URI

https://api.uniparthenope.it/manifest

URI Parameters

HTTP Method

GET

Resource Formats

application/json

Authentication

Responses

200 OK OK
201-Created-No content
231-custom-Info not avaiable
400-Bad Request-Bad Request
401-Not found-Not found


3. Get the API actions

Description:

Return the API actions. Applicable to all hosted APIs as /apiname/actions

URI

https://api.uniparthenope.it/actions

URI Parameters

HTTP Method

GET

Resource Formats

application/json

Authentication

Responses

200 OK OK
201-Created-No content
231-custom-Info not avaiable
400-Bad Request-Bad Request
401-Not found-Not found


4. Get the static file

Description:

Return a statically stored file

URI

https://api.uniparthenope.it/static/<filepath:path>

URI Parameters

HTTP Method

GET

Responses

200 OK OK
201-Created-No content
231-custom-Info not avaiable
400-Bad Request-Bad Request
401-Not found-Not found


5. Authenticate an user

Description:

Use radius/uniparthenope in order to authenticate an user by name and password

URI

https://api.uniparthenope.it/user/radius/auth

URI Parameters

user User The username
passw The password

HTTP Method

POST

Responses

200 OK OK
201-Created-No content
231-custom-Info not avaiable
400-Bad Request-Bad Request
401-Not found-Not found


6. Begin the user registration procedure

Description:

If the user is valid, send a confirmation code by email

URI

https://api.uniparthenope.it/user/request

URI Parameters

email The user email
passw The user password (max 16 characters)
first First Name
last Last Name
inst The user institution

HTTP Method

POST

Responses

200 OK OK
201-Created-No content
231-custom-Info not avaiable
400-Bad Request-Bad Request
401-Not found-Not found


7. Begin the key registration procedure

Description:

If the user is valid (use the /user/request action before), send a confirmation code by email

URI

https://api.uniparthenope.it/key/request

URI Parameters

email The user email
passw The user password (max 16 characters)
apiname The name of the API which the user is requesting the key
appname The application name which the API key will be used with

HTTP Method

POST

Responses

200 OK OK
201-Created-No content
231-custom-Info not avaiable
400-Bad Request-Bad Request
401-Not found-Not found


8. Get the in production API URLs list

Description:

Return a listof all APIs in production mode.

URI

https://api.uniparthenope.it/list

URI Parameters

HTTP Method

GET

Resource Formats

application/json

Authentication

Responses

200 OK OK
201-Created-No content
231-custom-Info not avaiable
400-Bad Request-Bad Request
401-Not found-Not found