-
Notifications
You must be signed in to change notification settings - Fork 1
Understanding the API
The four platforms currently supported by the content repo are Web, Whatsapp, Viber and Messenger. The API only returns results for one platform at a time depending on which platform is requested.
In order to retrieve content for a platform, the following endpoints are accepted
/api/v2/pages/<page-id>/?whatsapp=True
/api/v2/pages/<page-id>/?viber=True
/api/v2/pages/<page-id>/?sms=True
/api/v2/pages/<page-id>/?ussd=True
/api/v2/pages/<page-id>/?messenger=True
If no platform is provided in the query string, the API will return the web content.
If a platform has been requested but has not been enabled on the CMS no content will be returned
For Whatsapp, Viber, SMS, USSD and Messenger, each text block in the CMS counts as 1 message. If no message index is sent in the query string, the API will return the first message. Below are examples of how to request specific messages.
/api/v2/pages/<page-id>/?whatsapp=True&message=1
/api/v2/pages/<page-id>/?viber=True&message=4
/api/v2/pages/<page-id>/?messenger=True&message=2
/api/v2/pages/<page-id>/?sms=True&message=3
/api/v2/pages/<page-id>/?ussd=True&message=5
The content body that is returned will return the indexes of the previous and next messages as well, and None if no previous or next message.
You can paginate content pages by adding a limit and an offset. The limit is the page size, and the offset is the amount to start from. For example:
/api/v2/pages/?offset=2&limit=2 will give the second page with 2 results
/api/v2/pages/?offset=4&limit=2 will give the third page with 2 results
/api/v2/pages/?tag=relationships will give all the articles that have been tagged for relationships
More information about fetching content from the API can be seen here