Feature Highlights
- Getting Started
- API Overview
- Tutorials
- Authentication
- Security Recommendations
- Known Issues
- API Support
1. Getting Started
CodeMunch API is designed to give you complete control over your own data. This gives developers complete access to CodeMunch data. Using API, developers can post job, get job listings, get career status, follow careers etc. API is our ongoing effort to add more data syndication capabilityt in CodeMunch platform. We have taken partial set of functions to expose via API, rest we will add as we scale our API development efforts.
Before starting, every developer should know few things about CodeMunch api.
(i) Contents of FAQ
(II) You can not make unlimited calls
(iii) API is entirely HTTP based
(iv) API is a RESTful resource
2. API Overview
The CodeMunch REST API methods allow developers to access core CodeMunch
data. This includes job list data, user jobs data and job detail information data.
To learn about the methods and data available through the API, review the
CodeMunch API technical documenation.
We publicly disclose known issues and enhancements. Known issues and enhancement priorities can be viewed on our issues list. Long term goals are recorded in the roadmap document.
3. Tutorials
We will be adding tutorials describing how to use CodeMunch API for listing job openings.
4. Authentication
Right now we support basic authentication. But to take care security of username/password of users, we authenticate user based on md5 encrypted key. Very soon we will support oauth for better security.
5- Rate Limiting
The CodeMunch API only allows clients to make a limited number of calls in a given hour.
The default rate limit for calls is 100 requests per hour. Right now does IP based rate limiting.
Rate limiting application will get HTTP 400 response code.
5. Security Recommendations
Dont share your publisher key as it is main authentication key till we implement oauth.
6. Known Issues
Known issues are listed on issues list.
Known issues are also posted regularly on
- @codemunchapi on Twitter.
- CodeMunch API Annoncements Google group.
7. API Support
The API is updated regularly. We do our best to communicate these changes. Discuss and share your thoughts using @codemunchapi on Twitter.
8. Sample Code