Files
laatzen/LaaProductionWeb/LaaProduction.Web/Controllers/API/README.md
T
2023-06-19 15:45:20 +02:00

23 lines
1.6 KiB
Markdown

Laa Production API
---
1. **Base address** - http://sla12iis01.emea.sensus.net
1. **Authentication & Authorization** - each user has his own set of roles and allowed functions to access within his employee account's. Authentication succeeds over username, password and software name.
1. **POST: /LaaProductionWeb/api/personalization/login** - in order to authenticate particular user and obtain an authorization token use following parameters in the request body in json format:
- **Username** - required string. Should match a username saved in the database.
- **Password** - required hash string. Should match the password hash for the above entered username.
- **Software** - required string. As software name use the assembly name that calls this API.
- only if authentication succeeds you will receive in response a string (**{token}**) that should be used for further authorization else error message is received.
1. **Authorization: Bearer {token}** - is the scheme to use within the authorization and further API calls on all other routes.
1. **Wildcard search:**
1. **GET: /LaaProductionWeb/api/search/wildcard** - returns a list of possible fields to return when searching. Default are all fields returned to the client.
1. **POST: /LaaProductionWeb/api/search/wildcard** - returns a list of found results. Within the searching you should use following parameters in the request body in json format:
- **Token** - search string. Requires from 3 up to 50 - letters, digits and or (" ", "-") charachters.
- **Fields** - optional. List of fields to return.