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/17 18:26] clubadmin [Authentication] |
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 " | 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. | 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. The client session is stored on the client. The server is stateless means that every server can service any client at any time, there is no session affinity or sticky sessions | + | 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 30: | Line 35: | ||
| The getmember API needs an id or uid or email, when none are provided you will get HTTP 400. | The getmember API needs an id or uid or email, when none are provided you will get HTTP 400. | ||
| - | https://demo.clubplanner.be/ | + | https://YOUR-ENDPOINT.clubplanner.be/ |
| Return: | Return: | ||
preface.1518888398.txt.gz · Last modified: 2018/02/17 19:26 (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
