Open endpoints require no Authentication.
- Health :
GET /api/v1/health
Closed endpoints require a valid X-Davis-API-Token to be included in the header of the request. Token needs to be configured in .env file (as a environment variable API_KEY) and can be generated using php bin/console api:generate command.
When API_KEY is not set, the API endpoints are disabled and will return a 500 error if accessed.
Each endpoint displays information related to the User:
- Get Users :
GET /api/v1/users - Get User Details :
GET /api/v1/users/:user_id
Endpoints for viewing and modifying user calendars.
- Show All User Calendars :
GET /api/v1/calendars/:user_id - Show User Calendar Details :
GET /api/v1/calendars/:user_id/:calendar_id - Create User Calendar :
POST /api/v1/calendars/:user_id/create - Edit User Calendar :
PUT /api/v1/calendars/:user_id/:calendar_id - Delete User Calendar :
DELETE /api/v1/calendars/:user_id/:calendar_id - Show User Calendar Shares :
GET /api/v1/calendars/:user_id/shares/:calendar_id - Share User Calendar :
POST /api/v1/calendars/:user_id/share/:calendar_id/add - Remove Share User Calendar :
POST /api/v1/calendars/:user_id/share/:calendar_id/remove