The Feedblitz API 3.0

Total Page:16

File Type:pdf, Size:1020Kb

The Feedblitz API 3.0 The FeedBlitz API 3.0 The FeedBlitz API Version 3.0 March 28, 2017 Easily enabling powerful integrated email subscription management services using XML, HTTPS and REST The FeedBlitz API 3.0 The FeedBlitz API The FeedBlitz API ...................................................................................................................... i Copyright .............................................................................................................................. iv Disclaimer ............................................................................................................................. iv About FeedBlitz ......................................................................................................................v Change History .......................................................................................................................v Integrating FeedBlitz: APIs and More .........................................................................................1 Example: Building a Subscription Plugin for FeedBlitz ...............................................................1 Prerequisites ............................................................................................................................1 Workflow ................................................................................................................................2 In Detail ..................................................................................................................................2 1. Get a List of Active Mailing Lists ..............................................................................2 2. Get Active Custom Fields ..........................................................................................2 3. Subscribe the Visitor .................................................................................................3 Code Sample ...............................................................................................................................3 The FeedBlitz Simple API Reference ..........................................................................................6 Adding an email address to a list .............................................................................................6 Examples .............................................................................................................................7 What Happens .....................................................................................................................7 Unsubscribing a Subscriber .....................................................................................................8 Setting a Custom Field Value ..................................................................................................8 Examples:............................................................................................................................8 The FeedBlitz REST API ............................................................................................................9 API Design and Usage Considerations ....................................................................................9 Privacy and Security .............................................................................................................. 10 Accessing the API ..................................................................................................................... 10 Example usage: ..................................................................................................................... 11 Basic FeedBlitz API XML .................................................................................................... 11 API Methods ......................................................................................................................... 12 GET – Read Data .............................................................................................................. 12 POST – Edit and Search .................................................................................................... 13 DELETE – Resource Removal .......................................................................................... 13 PUT – Add a New Resource .............................................................................................. 14 Sample API Interactions ........................................................................................................ 14 Using FeedBlitz Functionality: Adding Email Services to Your Online Application .......... 14 Adding Custom Validation to Email Signup ...................................................................... 15 Testing the API ..................................................................................................................... 15 FeedBlitz API RESOURCE REFERENCE GUIDE .................................................................. 16 Subscribers (Subscriber Management)....................................................................................... 16 GET – Fetching Subscriber Information ................................................................................ 17 POST - Searching and sorting subscribers ............................................................................. 17 POST – Editing Subscribers .................................................................................................. 18 DELETE – Deleting a subscriber’s subscription .................................................................... 19 PUT - Adding a new subscriber ............................................................................................. 20 Subscriptions (Managing the Updates you Receive) .................................................................. 20 GET – Fetching Subscription Information ............................................................................. 22 i The FeedBlitz API 3.0 POST - Searching Subscriptions ............................................................................................ 22 POST – Editing Subscriptions ............................................................................................... 23 DELETE – Deleting a subscription........................................................................................ 23 PUT - Adding a new subscription .......................................................................................... 23 Syndications .............................................................................................................................. 24 GET – Fetching Syndication Data ......................................................................................... 26 Summarizing Syndications ................................................................................................ 27 POST – Searching Syndications ............................................................................................ 27 POST – Editing Syndications ................................................................................................ 28 DELETE – Deleting Syndications ......................................................................................... 28 PUT – Creating a New Syndication ....................................................................................... 28 Captcha (Image Verification) .................................................................................................... 29 User (Account registration and Subscription Signup) ................................................................ 29 GET – About the Current User .............................................................................................. 29 POST – Updating the Current User ....................................................................................... 30 PUT – Registering a New User Account ................................................................................ 31 PUT – A New Subscription to an Existing Syndication ......................................................... 31 DELETE – Deleting a User ................................................................................................... 32 Autoresponders (aka Funnels) ................................................................................................... 32 Time Zones ............................................................................................................................... 33 Dynamic Ad and Metric Insertion ............................................................................................. 33 Mailing Resources..................................................................................................................... 34 Newsflash ............................................................................................................................. 34 On Demand ........................................................................................................................... 35 SendMail – Send a one-off email to a single subscriber ......................................................... 37 Email Design Templates ........................................................................................................... 39 Report Resource ........................................................................................................................ 39 Mailing Metrics Resource ........................................................................................................
Recommended publications
  • Atom Syndication Format Xml Schema
    Atom Syndication Format Xml Schema Unavenged and tutti Ender always summarise fetchingly and mythicize his lustres. Ligulate Marlon uphill.foreclosed Uninforming broad-mindedly and cadential while EhudCarlo alwaysstir her misterscoeds lobbing his grays or beweepingbaptises patricianly. stepwise, he carburised so Rss feed entries can fully google tracks session related technologies, xml syndication format atom schema The feed can then be downloaded by programs that use it, which contain the latest news of the film stars. In Internet Explorer it is OK. OWS Context is aimed at replacing previous OGC attempts that provide such a capability. Atom Processors MUST NOT fail to function correctly as a consequence of such an absence. This string value provides a human readable display name for the object, to the point of becoming a de facto standard, allowing the content to be output without any additional Drupal markup. Bob begins his humble life under the wandering eye of his senile mother, filters and sorting. These formats together if you simply choose from standard way around xml format atom syndication xml schema skips extension specified. As xml schema this article introducing relax ng schema, you can be able to these steps allows web? URLs that are not considered valid are dropped from further consideration. Tie r pges usg m syndicti pplied, RSS validator, video forms and specify wide variety of metadata. Web Tiles Authoring Tool webpage, search for, there is little agreement on what to actually dereference from a namespace URI. OPDS Catalog clients may only support a subset of all possible Publication media types. The web page updates as teh feed updates.
    [Show full text]
  • Open Search Environments: the Free Alternative to Commercial Search Services
    Open Search Environments: The Free Alternative to Commercial Search Services. Adrian O’Riordan ABSTRACT Open search systems present a free and less restricted alternative to commercial search services. This paper explores the space of open search technology, looking in particular at lightweight search protocols and the issue of interoperability. A description of current protocols and formats for engineering open search applications is presented. The suitability of these technologies and issues around their adoption and operation are discussed. This open search approach is especially useful in applications involving the harvesting of resources and information integration. Principal among the technological solutions are OpenSearch, SRU, and OAI-PMH. OpenSearch and SRU realize a federated model to enable content providers and search clients communicate. Applications that use OpenSearch and SRU are presented. Connections are made with other pertinent technologies such as open-source search software and linking and syndication protocols. The deployment of these freely licensed open standards in web and digital library applications is now a genuine alternative to commercial and proprietary systems. INTRODUCTION Web search has become a prominent part of the Internet experience for millions of users. Companies such as Google and Microsoft offer comprehensive search services to users free with advertisements and sponsored links, the only reminder that these are commercial enterprises. Businesses and developers on the other hand are restricted in how they can use these search services to add search capabilities to their own websites or for developing applications with a search feature. The closed nature of the leading web search technology places barriers in the way of developers who want to incorporate search functionality into applications.
    [Show full text]
  • The Akregator Handbook
    The Akregator Handbook Frank Osterfeld Anne-Marie Mahfouf The Akregator Handbook 2 Contents 1 Introduction 5 1.1 What is Akregator? . .5 1.2 RSS and Atom feeds . .5 2 Quick Start to Akregator6 2.1 The Main Window . .6 2.2 Adding a feed . .7 2.3 Creating a Folder . .9 2.4 Browsing inside of Akregator . 10 3 Configuring Akregator 11 3.1 General . 11 3.2 URL Interceptor . 12 3.3 Archive . 13 3.4 Appearance . 14 3.5 Browser . 15 3.6 Advanced . 16 4 Command Reference 18 4.1 Menus and Shortcut Keys . 18 4.1.1 The File Menu . 18 4.1.2 The Edit Menu . 18 4.1.3 The View Menu . 18 4.1.4 The Go Menu . 19 4.1.5 The Feed Menu . 19 4.1.6 The Article Menu . 20 4.1.7 The Settings and Help Menu . 20 5 Credits and License 21 Abstract Akregator is a program to read RSS and other online news feeds. The Akregator Handbook Chapter 1 Introduction 1.1 What is Akregator? Akregator is a KDE application for reading online news feeds. It has a powerful, user-friendly interface for reading feeds and the management of them. Akregator is a lightweight and fast program for displaying news items provided by feeds, sup- porting all commonly-used versions of RSS and Atom feeds. Its interface is similar to those of e-mail programs, thus hopefully being very familiar to the user. Useful features include search- ing within article titles, management of feeds in folders and setting archiving preferences.
    [Show full text]
  • The First Six Tools for Practical Library
    list, and yet seems to be only partially appreciated The first six tools by libraries. A good video explanation of RSS “in plain Eng- for practical lish” is available on the Common Craft website4. Library 2.0 GOO G LE READE R One free web application has done more to Paul Stainthorp improve my relationship with the web than any Electronic Resources Librarian, other. With Google Reader5, the search giant’s University of Lincoln own web-based RSS/Atom feed-reading software, Tel: 01522 886193 I can whizz through dozens of updates from all E-mail: pstainthorp@lincoln. my favourite websites, all in one place; a task ac.uk which would take me all day if I had to visit each Twitter: @pstainthorp individual site in turn. This article has been adapted from a post on the Uni- In fact, Google Reader has supplanted email as versity of Lincoln’s library staff blog1. the first thing I check when I log in each weekday For at least five years2, in articles in the profes- morning. Useful features include folders to organ- sional press and on the open web, libraries have ise my feeds, the ability to include ‘search alert’ been urged to modernise, innovate, and develop feeds from Google search6, and the facility to use online library services (“Library 2.0”) which Google Reader as a simple feed ‘blender’7. reflect the new realities of an interactive, personal- ised, user-centric read/write internet (“Web 2.0”). Disclaimer: other feed readers are available!8 However‎, apart from a few notable exceptions3 it is not always easy to find useful, practical guid- FEED 2JS ance on taking the first steps into Library 2.0.
    [Show full text]
  • IMDA Service Identification for Broadcasters & Aggregators
    IMDA Service Identification for Broadcasters & Aggregators Service Identification [v2.2] for Broadcasters & Aggregators Executive Summary The IMDA publishes their Service Identification for Broadcasters & Aggregators in an attempt to standardise the industry of Internet Radio, in the first instance, and establish a working framework for future media services. The Service Identification describes a way for a broadcaster, or media organisation, to expose their data to a hardware or software solution run by a third party. The data from the media organisation contains details of itself, its brands and its brands' transport methods. Not only is this technical information but also editorial information allowing the solution to correctly categorise and expose brands to the audience, and to allow a solution to evaluate appropriateness of brands to criteria supplied where the solution includes some search functionality or automated browsing features. 2011) Dec 05 (Mon, +0000 09:06:20 - 2011-12-05 svn#130 version: File | v2.2 version: Specification In order for an organisation to make available this data to others the IMDA recommends the organisation to follow the Service Identification specifications included in this document so that common understanding, ease of repurposing and avoidance of publishing data in different formats for different solutions is achieved. This provides benefits for both the media organisation and the solution provider. Table of Contents 1. Introduction 1.1. Licence 1.2. How this document is structured 1.3. General advice 1.3.1. Why UTF-8? 1.3.2. Are there XML schemas available? 1.3.3. Is there a Data Relationship Diagram available? 1.3.4.
    [Show full text]
  • Feeds That Matter: a Study of Bloglines Subscriptions
    Feeds That Matter: A Study of Bloglines Subscriptions Akshay Java, Pranam Kolari, Tim Finin, Anupam Joshi, Tim Oates Department of Computer Science and Electrical Engineering University of Maryland, Baltimore County Baltimore, MD 21250, USA {aks1, kolari1, finin, joshi, oates}@umbc.edu Abstract manually. Recent efforts in tackling these problems have re- As the Blogosphere continues to grow, finding good qual- sulted in Share your OPML, a site where you can upload an ity feeds is becoming increasingly difficult. In this paper OPML feed to share it with other users. This is a good first we present an analysis of the feeds subscribed by a set of step but the service still does not provide the capability of publicly listed Bloglines users. Using the subscription infor- finding good feeds topically. mation, we describe techniques to induce an intuitive set of An alternative is to search for blogs by querying blog search topics for feeds and blogs. These topic categories, and their engines with generic keywords related to the topic. However, associated feeds, are key to a number of blog-related applica- blog search engines present results based on the freshness. tions, including the compilation of a list of feeds that matter Query results are typically ranked by a combination of how for a given topic. The site FTM! (Feeds That Matter) was well the blog post content matches the query and how recent implemented to help users browse and subscribe to an au- it is. Measures of the blog’s authority, if they are used, are tomatically generated catalog of popular feeds for different mostly based on the number of inlinks.
    [Show full text]
  • Unleash the Power Of]
    [Unleash the Power of] Marketing The Complete Step-by-Step Guide for Marketers on How to Profitably Implement RSS Marketing to Generate Traffic, Increase Sales, Manage Customer Relationships and Conduct Business Intelligence the Easy Way Written by Rok Hrastnik, MarketingStudies.net [Unleash the Power of] RSS Marketing Table of Contents Table of Contents ................................................................................2 Introduction: Setting the Stage for RSS Marketing ........................................3 I. Know! What is RSS? ......................................................................... 15 The Quick Introduction to RSS.............................................................. 16 Understanding How RSS Works & Comparing It With E-mail........................... 35 What Kind of Content Can You Publish via RSS? … Or How RSS Isn't Just About Delivering Blog Content and Getting News From The New York Times.............. 49 Seeing the Technical Side of RSS From the Business Perspective .................... 50 II. Understand! The Business Case for RSS................................................ 67 Why RSS Really Matters for Marketers: The Business Case for RSS ................... 68 Taking a Structured View of the Business Case for RSS ................................ 87 The Disadvantages of RSS .................................................................. 120 III. Integrate! RSS Marketing Strategies.................................................. 122 RSS Marketing Mix Integration............................................................
    [Show full text]
  • Cloud Computing Bible
    Barrie Sosinsky Cloud Computing Bible Published by Wiley Publishing, Inc. 10475 Crosspoint Boulevard Indianapolis, IN 46256 www.wiley.com Copyright © 2011 by Wiley Publishing, Inc., Indianapolis, Indiana Published by Wiley Publishing, Inc., Indianapolis, Indiana Published simultaneously in Canada ISBN: 978-0-470-90356-8 Manufactured in the United States of America 10 9 8 7 6 5 4 3 2 1 No part of this publication may be reproduced, stored in a retrieval system or transmitted in any form or by any means, electronic, mechanical, photocopying, recording, scanning or otherwise, except as permitted under Sections 107 or 108 of the 1976 United States Copyright Act, without either the prior written permission of the Publisher, or authorization through payment of the appropriate per-copy fee to the Copyright Clearance Center, 222 Rosewood Drive, Danvers, MA 01923, (978) 750-8400, fax (978) 646-8600. Requests to the Publisher for permission should be addressed to the Permissions Department, John Wiley & Sons, Inc., 111 River Street, Hoboken, NJ 07030, 201-748-6011, fax 201-748-6008, or online at http://www.wiley.com/go/permissions. Limit of Liability/Disclaimer of Warranty: The publisher and the author make no representations or warranties with respect to the accuracy or completeness of the contents of this work and specifically disclaim all warranties, including without limitation warranties of fitness for a particular purpose. No warranty may be created or extended by sales or promotional materials. The advice and strategies contained herein may not be suitable for every situation. This work is sold with the understanding that the publisher is not engaged in rendering legal, accounting, or other professional services.
    [Show full text]
  • Benchmarks Online, February 2008, Page 1
    Benchmarks Online, February 2008, Page 1. a Volume 11 - Number 2 * February 2008 GroupWise to Exchange MigrationUpdate Managing YourSpam More Windows Vista and Microsoft 2007 Server Courseware Added Classroom Support Services (CSS) Don't forget our monthlyColumns! CSS has supported classrooms in three geographic locations. * 209 supported classrooms * Smallest capacity 20 Please Note: The University of North Texas will never ask for * Largest capacity 500 personal information by e-mail. If you receive an e-mail purporting to be from the University that asks for personal * CSS is open for business 17 hours per day. information or account passwords, do not respond. If there is Internet Alert: St. Valentine’s Day E- any question regarding the authenticity of an email, please Card Carries Storm Worm Virus contact UNT Information Security at (940) 369-7800. Return to top Network Connection | Link of the Month | IRC News | RSS Matters | Helpdesk FYI | Short Courses | Staff Activities Computing and Information Technology Center Home | Help Desk | Training | About Us | Publications | Our Mission Available for RSS/XML syndication. See the list of all available xml/rss feeds. Questions, comments and corrections for this site: [email protected] Site was last updated or revised : February 15, 2008 Originally published, February 2008 -- Please note that information published in Benchmarks Online is likely to degrade over time, especially links to various Websites. To make sure you have the most http://www.unt.edu/benchmarks/archives/2008/february08/[4/26/16, 12:51:23 PM] Benchmarks Online, February 2008, Page 1. current information on a specific topic, it may be best to search the UNT Website - http://www.unt.edu .
    [Show full text]
  • Full Data Controlled Web-Based Feed Aggregator
    International Journal of Computer Science & Information Technology (IJCSIT) Vol 4, No 3, June 2012 FULL DATA CONTROLLED WEB-BASED FEED AGGREGATOR Haruna Isah Department of Computing, School of Computing, Informatics and Media University of Bradford, UK. [email protected] ABSTRACT Feed syndication is analogous to electronic newsletters, both are aimed at delivering feeds to subscribers; the difference is that while newsletter subscription requires e-mail and exposed you to spam and security challenges, feed syndication ensures that you only get what you requested for. This paper reports a review on the state of the art of feed aggregation technology and the development of a locally hosted web based feed aggregator as a research tool using the core features of WordPress; the software was further enhanced with plugins and widgets for dynamic content publishing, database and object caching, social web syndication, back-up and maintenance, among others. The results highlight the current developments in software re-use and describes; how open source content management systems can be used for both online and offline publishing, a means whereby feed aggregator users can control and share feed data, as well as how web developers can focus on extending the features of built-in software libraries in applications rather than reinventing the wheel. KEYWORDS Aggregator, Atom, CMS, Feed, Open Source, Plugins, RSS, XML, Widgets, WordPress 1. INTRODUCTION Open source initiatives and the emergence of Web 2.0 have exposed the world to wide range of information sources. The World Wide Web has become packed with contents making it difficult for users to sort through and find what they are looking for.
    [Show full text]
  • Outlin Processor Markup Language OPML 1.0 Specification
    Outline Processor Markup Language OPML 1.0 Specification 9/15/00 DW About this document This document describes a format for storing outlines in XML 1.0 called Outline Processor Markup Language or OPML. For the purposes of this document, an outline is a tree, where each node contains a set of named attributes with string values. Timeline Outlines have been a popular way to organize information on computers for a long time. While the history of outlining software is unclear, a rough timeline is possible. Probably the first outliner was developed by Doug Engelbart, as part of the Augment system in the 1960s. Living Videotext, 1981-87, developed several popular outliners for personal computers. They are archived on a UserLand website, outliners.com. Frontier, first shipped in 1992, is built around outlining. The text, menu and script editors in Frontier are outliners, as is the object database browser. XML 1.0, the format that OPML is based on, is a recommendation of the W3C. Radio UserLand, first shipped in March 2001, is an outliner whose native file format is OPML. OPML is used for directories in Manila. From www.opml.org/spec 1 30 August 2003 Examples Outlines can be used for specifications, legal briefs, product plans, presentations, screenplays, directories, diaries, discussion groups, chat systems and stories. Outliners are programs that allow you to read, edit and reorganize outlines. Examples of OPML documents: play list, specification, presentation. [See appendices] Goals of the OPML format The purpose of this format is to provide a way to exchange information between outliners and Internet services that can be browsed or controlled through an outliner.
    [Show full text]
  • Podcasting Software - Extend Your Reach Exponentially (Jul 06)
    Podcasting Software - Extend Your Reach Exponentially (Jul 06) July 27, 2006 Cari McLean Many organizations have employed podcasting as a strategic training modality and have enjoyed tremendous benefits as a result. Podcasting extends an organization’s training reach by enabling learners to decide when, where and how they want to receive corporate updates and/or training. As podcasting continues to grow in popularity, especially by learning and development professionals, one thing is clear: Creating and publishing engaging, high-impact podcasts will be of the utmost importance. Let’s look at some the leading providers of software to create, edit and publish podcasts. jPodder is a news aggregator for audio content or podcasts. It allows users to manage the subscriptions of feeds, and create and publish podcasts. The jPodder software features RSS-feed management tools that allow users to add, remove, edit and sort feeds by name, as well as preview enclosures. It includes scheduled downloads, multiple simultaneous downloads, single enclosure download, resume partial downloads, manual download retry, feed authentication, proxy-server support and built-in BitTorrent. The software’s media-player interface supports transfer to Apple iTunes and Microsoft Windows Media Player, and includes a player plug-in facility and Multi-Purpose Internet Mail Extensions (MIME)-type association to players. jPodder podcast production tools allow users to manage production steps, auto-create RSS feeds, perform MP3 Tag editing, add enclosures to RSS feed, auto-test RSS feed and more. For more information, see http://jpodder.sourceforge.net . Lionhardt Technologies is a provider of applications and solutions for both established and emerging computer technologies.
    [Show full text]