If you are not eligible to use one of our ready made plugins, there are a few things you need to change in your CMS in order to integrate with News@me. The following is a high level introduction on the topic, for further questions don't hesitate to contact our support team.
For a detailed view of the API please visit developer.newsatme.com
Changes to the database schema
The first thing to do is to think about the introduction of a new field in your database where to store your News@me tags. If your CMS is already using tags, you can just duplicate the current data structure.
You may think this step is not mandatory if you already have tags in your CMS, we advise instead to keep a separate field for your CMS's tags and News@me tags.
Save new articles to News@me
You should intercept the moment in which your articles are published and perform an API call to send the article to News@me as described in the API documentation. The same API call is to be used when further edits to the article are saved. Only save articles to News@me when the are publicly available.
Delete articles from News@me
When you delete an article from your CMS you'll need to perform an API call to the appropriate endpoint in order to delete it. News@me does not have knowledge of "unpublished" or "draft". You will thus need to delete articles from your News@me database depending on your CMS's workflow. For instance, if the status of your article is changed from 'published' to 'trashed', you should delete the article with the appropriate API call.
Show the sync status
Given the nature of the web transactions, it may happen for the article to be saved to your CMS's database but now to News@me. Your CMS should be programmed in a way to always check for the current article to be in sync with News@me and show a prompt message inviting to re-save it otherwise. This is the meaning of the "signature" endpoint, a special API endpoint designed for this purpose. The "signature" endpoint is expected to receive your current "signature" for the article and will inform you if the article needs to be re-saved.
The value of the "signature" may change depending on the CMS implementation. We recommend to use an MD5 digest of anything you think is suitable to identify the current version of your article.
You must decide wisely which algorithm to pick to generate the "signature" attribute of your articles. Changing it in the future may result in false positive out-of-date notices.
Sometimes it's enough to use the date of last update. For extreme reliability, we advise to make a hash of the article's full content, title, News@me tags and URL. If you need further informations on this topic don't hesitate to contact our support.
Get a list of tags and subscribers to help you tag wisely
In order to better decide which tags to use for your topics, News@me provides an API endpoint to retrieve a list of tags, where each tag comes with the count of people who subscribed to that tag. You can use this list to populate an autocomplete input field in your article's edit page. With this information you get a pretty accurate idea of how many people the article you are writing is going to hit.
How to deal with 'old articles'
From the moment you start using News@me, you start populating your remote database with articles which are eligible to be submitted into an email digest to your subscribed readers. But what about old articles?
Old articles are a precious source of traffic for your website, but since they don't have News@me tags associated, any subscription on those articles will be useless (subscribers won't be associated to any tag, thus resulting in no emails sent). To deal with this scenario we advise to take one of the following action.
Perform an update on your database, copying the value of your previously used "tags" field into the newly created "newsatme tags" field: i n this case you need to perform an update on your database, so to prepare the old articles to be treated like the new ones. This may not fit your case if you were not making previous use of tags in your CMS.
Dynamically deal with this status when a new subscription is registered: in this case, you decide which value to assign to the "tags_array" value, depending on the status of your News@me tags field. If the field is empty you may want to send the previously used tags field value.
Both are viable and result in the same effect. We advise to chose the first one whenever possible.
The subscription form
- include a placeholder DIV element where you want the widget to appear.
Where to show the subscription form
In order to maximize conversions, the form should be the very first element the user sees when the article completes, as if it were a natural prosecution of the article itself.