API.md

REST API v2.1 for phpMyFAQ 3.1

phpMyFAQ offers interfaces to access phpMyFAQ installations with other clients like the iPhone App. phpMyFAQ includes a REST API and offers APIs for various services like fetching the phpMyFAQ version or doing a search against the phpMyFAQ installation.

Open Endpoints

Open endpoints require no Authentication.

General APIs

• Version: GET /api/v2.1/version
• Language: GET /api/v2.1/language
• News: GET /api/v2.1/news
• Categories: GET /api/v2.1/categories
• Tags: GET /api/v2.1/tags
• Open Questions: GET /api/v2.1/open-questions

Search related APIs

• Search: GET /api/v2.1/search?q=<search string>
• Popular Searches: GET /api/v2.1/searches/popular

FAQ related APIs

• Attachments: GET /api/v2.1/attachments
• Comments: GET /api/v2.1/comments
• All FAQs: GET /api/v2.1/faqs
• All FAQs per Category: GET /api/v2.1/faqs/:categoryId
• All FAQs per Tags: GET /api/v2.1/faqs/tags/:tagId
• FAQ: GET /api/v2.1/faq/:faqId
• FAQ as PDF: GET /api/v2.1/faq/:faqId?filter=pdf
• Latest FAQs: GET /api/v2.1/faqs/latest
• Popular FAQs: GET /api/v2.1/faqs/popular
• Sticky FAQs: GET /api/v2.1/faqs/sticky

Login/Registration related APIs

• Login: POST /api/v2.1/login

Endpoints that require Authentication

Closed endpoints require a valid API client token to be included in the header of the request. An API client token can be acquired from the admin configuration.

FAQ related APIs

• Add FAQ: GET /api/v2.1/faq

Login/Registration related APIs

• Register: POST /api/v2.1/register