Documentation for Kaspars Vanilla API?
Hi there,
KUDOS for an excellent piece of software! Both to the vanilla team and to Kasper whose API addon is really nice to see in action. I am playing around with a task / project management web site project (playground) and plan to integrate vanilla via Kaspars API. I have user creation and deletion working (nearly) and before i digg myself deeper into this i was wondering if there is any more "sophisticated" API documentation available for kaspars REST calls?
Like how is the search call parameter query to be used? and many more.....
Would be really ncie if someone could shed a light on this
BR
Thomas
Best Answer
-
hgtonight
MVP
Welcome to the community!
@Kasper has documented his api application over on GitHub: https://github.com/kasperisager/vanilla-api/wiki
It sounds like you are mostly interested in the Endpoints article: https://github.com/kasperisager/vanilla-api/wiki/Endpoints
This addon maps endpoints to existing methods of Vanilla controllers. You will have to read the Vanilla source to figure out exactly what is done with the submitted parameters.
Check out the Documentation! We are always looking for new content and pull requests.
Click on insightful, awesome, and funny reactions to thank community volunteers for their valuable posts.
2
Answers
Welcome to the community!
@Kasper has documented his api application over on GitHub: https://github.com/kasperisager/vanilla-api/wiki
It sounds like you are mostly interested in the Endpoints article: https://github.com/kasperisager/vanilla-api/wiki/Endpoints
This addon maps endpoints to existing methods of Vanilla controllers. You will have to read the Vanilla source to figure out exactly what is done with the submitted parameters.
Search first
Check out the Documentation! We are always looking for new content and pull requests.
Click on insightful, awesome, and funny reactions to thank community volunteers for their valuable posts.