RebelMouse Public API

Authorization

Our REST API service uses key-based authorization that can be managed in your Account page. You can find your API key in the form of a 64-character string. But please note that we use this unique key to identify your account, so please do not share it with anyone.


All client requests are authorized using valid API keys via a specific HTTP header or query string. Query strings take priority over the HTTP header, so query strings will be considered if you send both at the same time.

Sending API Key via Query String

In order to authorize requests using the " api_key" query string, you need to send it as follows:

<HTTP-METHOD> <domain>/api/<version>/<path>?api_key=<api_key>

Sending API Key via HTTP Header

In order to authorize requests using the " X-RMAuth" HTTP header method, you need to send it as follows:

<HTTP-METHOD> <domain>/api/<version>/<path> X-RMAuth: <api_key>

Unauthorized Requests

If you send invalid API keys, you will get a response with HTTP 403 Forbidden status and the following payload:

{ "status": { "code": null, "messages": ["API key is not valid"] }, "data": null }

Rawauthors.rst

Author API

The author API supports creating users that can be used to create drafts.

Creating Authors

Creates an author and sets its role as guest editor.

POST /api/1.1/authors

Parameters

Name Type Description
first_name String First name - Required
last_name String Last name - Required
email String User email - Required
password String User password - Required
about_html String User biography - Optional
image_id Integer ID of the uploaded image - Optional

Note:

  • image_id can be found as id in Image API response when uploading or editing images.

Response

{ "id": <id>, "name": "paulberry", "displayname": "Paul Berry", "about_html": "This is me", "bio": "", "photo": "https://<domain>/res/avatars/default", "fb_id": null, "profile_url": "https://<domain>/community/paulberry/" }

Rawdrafts.rst

Drafts API

The draft API supports creating drafts that can be used to publish content on your site.

Creating Drafts

Creates a draft and sets the current user as author by default.

POST /api/1.1/posts

Parameters

Name Type Description
headline String Headline - Required
body String Body - Optional
subheadline String Subheadline - Optional
tags Array of strings Tags - Optional
primary_tag String Primary tag - Optional
sections Array of strings Sections - Optional
primary_section String Primary section - Optional
og_title String Social headline - Optional
og_description String Social description - Optional
image_id Integer ID of the uploaded image - Optional
manual_image_crops Object Cropping calculated when uploading image - Optional

Note

  • primary_section and sections fields are eligible by title using insensitive case mode. "Home" can be passed if you want to set a draft in the home page.
  • image_id can be found as id in Image API response when uploading or editing images.
  • manual_image_crops can be also found as manual_image_crops in Image API response when editing images.

Response

The response can contain several fields, but we would like to highlight some of them that were specially requested:

Name Type Description
post_url String URL of the draft when it's published
draft_url String Composited by post_url + "?draft=1", which enables users to see the draft page
slug String URL path from post_url

Rawimages.rst

Image API

The Image API supports uploading and editing images that can be used for splash posts, teasers, social teasers, and even features other than posts — such as authors creation.

Ratios

Every site on the RebelMouse platform has its own image-cropping settings configured. These settings are useful whenever an image is going to be resized or cropped. The settings are considered in every process related to images, and each resized or cropped image usually has a different purpose depending on page type.

For Axios, we have the following ratios configured:

Title Code Sizes
FHD 16x9
  • 960x540
  • 480x270
Wide 2x1
  • 1200x600
  • 600x300
Medium 2x1
  • 1200x600
  • 600x300
Tall 1x1
  • 600x600
Instant 9x16
  • 700x1245

Uploading Images

Upload an image, sending its content as a part of an HTTP request body or a URL as part of a JSON document.

POST /api/1.3/images

Parameters

Name Type Description
image_url String An image URL location - Optional

Note:

Multiple files can be also sent as part of an HTTP request. They are used only if image_url is not used in the HTTP request.

Response

For a single image uploaded:

{ "is_animated_gif": false, "task_id": "c3e2a367-24cb-426f-9179-457a0e0ea9ec", "height": 511, "shortcode_id": "7229TA1498262817", "iptc": { "by-line": "", "caption/abstract": "" }, "id": <id>, "shortcode_params": { "is_animated_gif": false, "crop_info": "%22%7B%22image%22%3A%20%22https%3A%2F%2Fs3.amazonaws.com%2Fdev-assets.rbl.ms%2F%3Cid%3E%2Forigin.jpg%22%2C%20%22thumbnails%22%3A%20%7B%22origin%22%3A%20%22https%3A%2F%2Fs3.amazonaws.com%2Fdev-assets.rbl.ms%2F%3Cid%3E%2Forigin.jpg%22%2C%20%2235x35%22%3A%20%22https%3A%2F%2Fs3.amazonaws.com%2Fdev-assets.rbl.ms%2F%3Cid%3E%2F35x35.jpg%22%2C%20%221200x800%22%3A%20%22https%3A%2F%2Fs3.amazonaws.com%2Fdev-assets.rbl.ms%2F%3Cid%3E%2F1200x800.jpg%22%2C%20%22480x270%22%3A%20%22https%3A%2F%2Fs3.amazonaws.com%2Fdev-assets.rbl.ms%2F%3Cid%3E%2F480x270.jpg%22%2C%20%22700x1245%22%3A%20%22https%3A%2F%2Fs3.amazonaws.com%2Fdev-assets.rbl.ms%2F%3Cid%3E%2F700x1245.jpg%22%2C%20%22980x%22%3A%20%22https%3A%2F%2Fs3.amazonaws.com%2Fdev-assets.rbl.ms%2F%3Cid%3E%2F980x.jpg%22%2C%20%22600x%22%3A%20%22https%3A%2F%2Fs3.amazonaws.com%2Fdev-assets.rbl.ms%2F%3Cid%3E%2F600x.jpg%22%2C%20%22600x600%22%3A%20%22https%3A%2F%2Fs3.amazonaws.com%2Fdev-assets.rbl.ms%2F%3Cid%3E%2F600x600.jpg%22%2C%20%22960x540%22%3A%20%22https%3A%2F%2Fs3.amazonaws.com%2Fdev-assets.rbl.ms%2F%3Cid%3E%2F960x540.jpg%22%2C%20%22600x300%22%3A%20%22https%3A%2F%2Fs3.amazonaws.com%2Fdev-assets.rbl.ms%2F%3Cid%3E%2F600x300.jpg%22%2C%20%22210x%22%3A%20%22https%3A%2F%2Fs3.amazonaws.com%2Fdev-assets.rbl.ms%2F%3Cid%3E%2F210x.jpg%22%2C%20%22300x%22%3A%20%22https%3A%2F%2Fs3.amazonaws.com%2Fdev-assets.rbl.ms%2F%3Cid%3E%2F300x.jpg%22%2C%20%22600x400%22%3A%20%22https%3A%2F%2Fs3.amazonaws.com%2Fdev-assets.rbl.ms%2F%3Cid%3E%2F600x400.jpg%22%2C%20%221200x600%22%3A%20%22https%3A%2F%2Fs3.amazonaws.com%2Fdev-assets.rbl.ms%2F%3Cid%3E%2F1200x600.jpg%22%7D%2C%20%22manual_image_crops%22%3A%20%7B%2216x9%22%3A%20%7B%22width%22%3A%20512%2C%20%22top%22%3A%20222%2C%20%22height%22%3A%20289%2C%20%22left%22%3A%200%2C%20%22sizes%22%3A%20%5B%22960x540%22%2C%20%22480x270%22%5D%7D%2C%20%222x1%22%3A%20%7B%22width%22%3A%20512%2C%20%22top%22%3A%20255%2C%20%22height%22%3A%20256%2C%20%22left%22%3A%200%2C%20%22sizes%22%3A%20%5B%221200x600%22%2C%20%22600x300%22%5D%7D%2C%20%223x2%22%3A%20%7B%22width%22%3A%20512%2C%20%22top%22%3A%20169%2C%20%22height%22%3A%20342%2C%20%22left%22%3A%200%2C%20%22sizes%22%3A%20%5B%221200x800%22%2C%20%22600x400%22%5D%7D%2C%20%221x1%22%3A%20%7B%22width%22%3A%20109%2C%20%22top%22%3A%20402%2C%20%22height%22%3A%20109%2C%20%22left%22%3A%200%2C%20%22sizes%22%3A%20%5B%22600x600%22%5D%7D%2C%20%229x16%22%3A%20%7B%22width%22%3A%20117%2C%20%22top%22%3A%20303%2C%20%22height%22%3A%20208%2C%20%22left%22%3A%200%2C%20%22sizes%22%3A%20%5B%22700x1245%22%5D%7D%7D%7D%22%0A", "original_size": "512x511", "expand": 1 }, "thumbnails": { "origin": "https://s3.amazonaws.com/dev-assets.rbl.ms/<id>/origin.jpg", "35x35": "https://s3.amazonaws.com/dev-assets.rbl.ms/<id>/35x35.jpg", "1200x800": "https://s3.amazonaws.com/dev-assets.rbl.ms/<id>/1200x800.jpg", "480x270": "https://s3.amazonaws.com/dev-assets.rbl.ms/<id>/480x270.jpg", "700x1245": "https://s3.amazonaws.com/dev-assets.rbl.ms/<id>/700x1245.jpg", "980x": "https://s3.amazonaws.com/dev-assets.rbl.ms/<id>/980x.jpg", "600x": "https://s3.amazonaws.com/dev-assets.rbl.ms/<id>/600x.jpg", "600x600": "https://s3.amazonaws.com/dev-assets.rbl.ms/<id>/600x600.jpg", "960x540": "https://s3.amazonaws.com/dev-assets.rbl.ms/<id>/960x540.jpg", "600x300": "https://s3.amazonaws.com/dev-assets.rbl.ms/<id>/600x300.jpg", "210x": "https://s3.amazonaws.com/dev-assets.rbl.ms/<id>/210x.jpg", "300x": "https://s3.amazonaws.com/dev-assets.rbl.ms/<id>/300x.jpg", "600x400": "https://s3.amazonaws.com/dev-assets.rbl.ms/<id>/600x400.jpg", "1200x600": "https://s3.amazonaws.com/dev-assets.rbl.ms/<id>/1200x600.jpg" }, "manual_image_crops": { "16x9": { "width": 512, "top": 222, "height": 289, "left": 0, "sizes": [ "960x540", "480x270" ] }, "2x1": { "width": 512, "top": 255, "height": 256, "left": 0, "sizes": [ "1200x600", "600x300" ] }, "3x2": { "width": 512, "top": 169, "height": 342, "left": 0, "sizes": [ "1200x800", "600x400" ] }, "1x1": { "width": 109, "top": 402, "height": 109, "left": 0, "sizes": [ "600x600" ] }, "9x16": { "width": 117, "top": 303, "height": 208, "left": 0, "sizes": [ "700x1245" ] } }, "filename": "image_hmXa6R.jpg", "width": 512, "media_html": "<img src=\"https://s3.amazonaws.com/dev-assets.rbl.ms/<id>/980x.jpg\" id=\"89b1c\" class=\"rm-shortcode\" data-rm-shortcode-id=\"7229TA1498262817\" data-rm-shortcode-name=\"rebelmouse-image\" >", "shortcode": "<img src="https://assets.rbl.ms/%3Cid%3E/980x."> ", "image_original_url": "<img src="https://s3.amazonaws.com/dev-assets.rbl.ms/<id>/origin.jpg">" }

For multiple images uploaded:

It takes the same schema for each image uploaded, but in the form of an array.

Editing Images

Editing an image to create copies with specific dimensions.

PUT /api/1.3/images/<id>

Parameters

Name Type Description
image_url String An image URL location - Required
manual_image_crops Object Crop setting for resizing an image - Optional

Manual Image Cropping

Manual image cropping depends on the ratios that have been configured for the site. It must be an object, whose keys must be the ratio codes. The values should contain the following information:

Name Type Description
top Integer Absolute top coordinate
left Integer Absolute left coordinate
height Integer Absolute height coordinate
width Integer Absolute width coordinate
imgHeight Integer Height of the original image
imgWidth Integer Width of the original image

Example

{ "16x9": { "top": 222, "left": 0, "height": 289, "width": 512, "imgWidth": 512, "imgHeight": 511 }, "2x1": { "top": 255, "left": 0, "height": 256, "width": 512, "imgWidth": 512, "imgHeight": 511 }, "3x2": { "top": 169, "left": 0, "height": 342, "width": 512, "imgWidth": 512, "imgHeight": 511 }, "1x1": { "top": 402, "left": 0, "height": 109, "width": 109, "imgWidth": 512, "imgHeight": 511 }, "9x16": { "top": 303, "left": 0, "height": 208, "width": 117, "imgWidth": 512, "imgHeight": 511 } }

Response

It takes the same schema from uploading images. Only one image can be edited per request.

Rawwebhooks.rst

Webhooks

Webhooks allow you to receive notification of certain events from the RebelMouse platform. HTTP POST requests are performed for the configured URL you provide to us. These requests are formed with the following headers:

Name Value
User-Agent RebelMouse/0.1 Mozilla/5.0 (compatible; http://rebelmouse.com) Gecko/20100101 Firefox/7.0.1
Content-Type application/json

Published Post

You can receive a notification when a post is published. You will receive the following information:

Name Type Description
post_id Integer ID of the post
post_url String URL of the published post

Click here for more on RebelMouse Public API v1.2.

You're almost there! Fill out the form below and a Rebel will contact you within one business day.

x

How Axios Built on RebelMouse

The Axios founding team is composed of the industry veterans who built Politico and shaped The New York Times. They had a vision for building a next-generation media site that would not only win in the world of social, but would also build real loyalty and a subscriber base.

Industry: News Media
Headquarters: Washington, DC
Website: Axios.com

Axios is a new media company delivering vital, trustworthy news and analysis in the most efficient, illuminating, and shareable ways possible. They offer a mix of original and smartly narrated coverage of media trends, tech, business, and politics with expertise, voice, and smart brevity — on a new and innovative mobile platform.



With some of the best writers in the world, Axios knew that, to be successful, they would need to provide next-generation authoring tools as well as a next-generation front-end experience for their readers.

Project Requirements:

  • Get to launch quickly while still having tremendous depth in technology
  • Build a next-generation media property
  • Empower editors with technology for breaking news
  • Build a CMS that manages and elegantly assembles content into articles
Keep reading... Show less

Important: Mandatory Facebook Upgrade Arrives in 2018

The media world is ever-evolving, but one thing is abundantly clear: Facebook and Google, the almighty duopoly, have a firm grip on digital ad revenue. While successful media companies and brands struggle to meet revenue goals, the platforms are reaching new heights. As the state of digital media continues to puzzle publishers in 2017, it can be hard to strategize with all the changes and updates these mega platforms throw our way.

We often see media companies frantically trying to adopt a new strategy to monetize without knowing how to successfully execute. Case in point: The pivot-to-video trend, which has really been more like a pivot to ad-backed digital media, is causing editorial teams to take drastic measures prematurely.

RebelMouse is here to make life easier, and help you with your strategy along the way. Our team of experts live and breathe digital content. We stay ahead of all the algorithm updates, the platform changes, etc., so you can focus on producing great content. We help you take back control of your content and stay abreast of the best monetization strategies so you can bring in real revenue.

One of Facebook's recent updates makes it mandatory to switch to their Monetization Manager by February 2018. We'll walk you through this process so this change doesn't affect your monetization strategy.

Keep reading... Show less

RebelMouse vs. WordPress VIP

After building the product for Huffington Post, and owning the product and engineering groups at AOL after we were acquired, it was clear to me there was a huge gap between what the current CMS offering gave the world and what the world needed. Five years later we are at scale, moving the needle and doing to WordPress what Airbnb did to Craigslist.

Keep reading... Show less

NEW! Google Analytics Tracking for Facebook Instant Articles

We're a bunch of traffic junkies here at RebelMouse. We geek out over data, and we want our clients to geek out too over the insights we provide them. That's why we obsess over our clients' metrics on a daily basis. It's our belief that a clear understanding of data will drive strategy adjustments that lead to real audience growth. But this means that your traffic overview has to be as clear and easy to read as possible. Enter one of our latest updates.

A lot of our clients prefer to use a separate Google Analytics profile to track their Facebook Instant Articles traffic, and now this is incredibly easy to set up in our platform. We have a sophisticated Google Analytics integration that can accurately track every one of your UTM mediums, including Google AMP, Facebook Instant Articles, and traditional website traffic. It's a feature that, if we're honest, Google Analytics does very poorly on its own.

Keep reading... Show less

You're almost there! Fill out the form below and a Rebel will contact you within one business day.

x

Strategy Services from Experts in Growth

At RebelMouse, we talk a lot about being born in the age of social. We went viral in 2012 as being the first content aggregator and the internet's first "social front page."

Keep reading... Show less

Meet the Investors Behind RebelMouse

RebelMouse founder and CEO, Paul Berry, was the former CTO of HuffPost where he led product development. Paul has managed small, agile teams for 20 years, but has also led teams of 450+ people. He understands how engineers, product, design, UX, and editorial teams can come together with chemistry that produces results.

RebelMouse is fortunate to be backed by an impressive list of investors, including Ken Lerer, Eric Hippeau, Jonah Peretti, Jordan Levy, Fred Harmon, and more. See the full list below.

Keep reading... Show less

Video Ads = Toxic

Facebook has implemented a ton of changes recently that have been affecting publishers' reach. And while it seems nearly impossible to figure out a winning strategy while juggling all of the platform's algorithm updates, one thing is abundantly clear:

Video ads are hurting your reach.

We're now finding that if you have a video ad on your site period, the Facebook gods are not going to favor you — and you'll most likely see a drop in reach.

Keep reading... Show less

The Reasons Why Indie Publishers Flourish on RebelMouse

We care about you. We care about you having a sustainable business.

And that means we care about everything — from revenue to traffic to how you can be sustainable long term. By using data across all our publishers, we can help you understand what's happening in the media world, how to leverage Facebook's algorithm changes, where your audience lives, and more. The digital landscape is constantly changing, and we are always studying its changes to help indie publishers break through the barriers of bureaucracy. Our goal is to give you an unfair advantage through badass tech that helps you understand how traffic distribution works. So you can get your voice heard. Loudly.

One of the best parts of living in the age of new media, and more importantly living within the social ecosystem, is that everyone has a chance to go viral. The chains surrounding public content that were once monopolized by corporations and agencies have now been put back into the hands of the users.

Keep reading... Show less