preface
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
preface [2018/02/16 17:57] clubadmin [Base URL] |
preface [2025/07/17 11:49] (current) clubadmin |
||
|---|---|---|---|
| Line 2: | Line 2: | ||
| Every API call that is sent to Club Planner API must be accompanied by a **token** that is preconfigured in the club planner parameters. | Every API call that is sent to Club Planner API must be accompanied by a **token** that is preconfigured in the club planner parameters. | ||
| + | For security reasons you should pass this token in the header as **x_auth_token**. | ||
| + | Note that the fixed token will be replaced in time with a more secure system. | ||
| + | |||
| + | Most API's also have a **from** optional parameter, this will be saved in the database as the user that created or changed the data. Examples for **from** can be " | ||
| + | We kindly ask to always provide this parameter with a useful value. | ||
| + | |||
| + | Most API's are **stateless** (unless mentioned) and can be called without a kind of connect or initialise. | ||
| + | By stateless it means that the server does not store any state about the client session on the server side. | ||
| ====== Security ====== | ====== Security ====== | ||
| - | Is over HTTPS and should never be used over HTTP | + | Is over HTTPS and should never be used over HTTP, when using important data please put this API behind a VPN. |
| + | |||
| + | Most api's are monitored and have logging (level of logging is configurable). | ||
| ====== Base URL====== | ====== Base URL====== | ||
| - | Is usaly the base url of the web platform + \api | + | Is usually |
| Example: https:// | Example: https:// | ||
| Line 16: | Line 26: | ||
| Calling the API over extensively or misuse can result in a disabled api. | Calling the API over extensively or misuse can result in a disabled api. | ||
| + | |||
| + | ====== Error handling ====== | ||
| + | |||
| + | When the api was unable to process the request a **BadRequest** (400 Bad Request) with the specified error message will be sent back. | ||
| + | |||
| + | |||
| + | Example: | ||
| + | The getmember API needs an id or uid or email, when none are provided you will get HTTP 400. | ||
| + | |||
| + | https:// | ||
| + | |||
| + | Return: | ||
| + | |||
| + | < | ||
| + | < | ||
| + | </ | ||
| + | |||
preface.1518800245.txt.gz · Last modified: 2018/02/16 18:57 (external edit)
Page Tools
Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
