Publishing API Introduction

In Falcon, a publishing is considered a draft or scheduled post which has not yet been published - Once the post has been published, it will be considered a publication.

The Publishing API allows your third-party software tool to access information relating to the existing publishings in your Falcon organization. Using the Publishing API, you can access, edit, add labels, and delete publishings.

Note:

This article offers an introduction to the Falcon Publishing API. For more information, please visit Falcon’s API Technical Documentation here. Don’t yet have access to Falcon APIs? Find out how to get access here.

What Features Are Available?

There are 12 endpoints available in the Publishing API:

  • Schedule Draft
  • Unschedule Draft
  • Copy Draft
  • Draft Status
  • Delete Draft
  • Get Labels
  • Add Labels
  • Remove Labels
  • Create Draft
  • Edit Draft
  • Get Draft
  • Get Locations (Facebook, Instagram, and Twitter)

Draft handling

Schedule Draft

Schedule an existing draft to be published at a future time. Using the schedule draft endpoint, you can specify the date, time, and timezone. Once scheduled, your post will be moved into the Scheduled section in Falcon.

Unschedule Draft

Using the Unschedule draft endpoint, you can remove the scheduled date and time for an existing scheduled post using the post ID. In Falcon, the post will be moved from Scheduled to Drafts.

Copy Draft

You can use the copy draft endpoint to copy the contents of an existing draft to create a new draft for different Channels. You can choose to create the new draft for one Channel, or several Channels belonging to the same network (Facebook, Twitter, Instagram, or LinkedIn). You will need the existing Draft ID along with the Channel IDs for the new drafts.

Note:

You can locate your Channel IDs via the Falcon platform and Falcon APIs. Find out more here.

Draft Status

Using an existing Draft ID, find out if your draft is still in draft form (not yet scheduled or published), unapproved, scheduled, failed, or published.

Delete Draft

Delete a draft from the Falcon Calendar using the existing Draft ID.

Label handling

Get Labels

Using the Draft ID, retrieve a list of all labels which have been attached to the draft.

Add Labels

Add one or more labels to an existing draft. You will need the Draft ID and the applicable Label IDs.

Note:

Your label IDs can be retrieved via the Falcon API. Find out more here.

Remove Labels

Remove one or more labels from an existing draft. You will need the Draft ID and the applicable Label IDs.

Getting, creating, and editing drafts by network

The endpoints listed below allow you to create and manage drafts for each network. However, the information required may vary per network due to different draft requirements. Please visit the API Technical Documentation for the full list of requirements by network.

Create Draft

Using one or more Channel IDs, you can create a brand-new draft by adding content and media (text, image, video, or link content), scheduling a date and time if applicable, and otherwise customizing your post, for example by enabling URL shortening or specifying a Publisher for Instagram content.

Note:

Please take care to make sure that your new draft is in line with the suitable types of posts supported by Falcon for each network. You can find out more here.

Edit Draft

Using a Draft ID, you can make changes to existing drafts, for example by changing the Channel, schedule date and time, links, media, or location.

Get Draft

Using a Draft ID, you can find out all relevant information about an existing draft. Along with an in-depth overview of the contents, such as the text, media, links, promotion, and scheduled status, you can also find internal Falcon data, such as the creator, user notes, number of copies, and any labels.

Get Locations

Applicable only for Facebook, Instagram, and Twitter, you can use the get location endpoint to search for valid locations you can add to your posts. Searching by name along with a Channel ID, you can choose to limit your results to a certain number. Your results will include a Place or Location ID and a name.

How Can I Find a Publishing ID?

There are two ways you can locate the Publishing ID for any existing draft:

Via the Content API

Using the Get Channel Content endpoint of the Content API, you can retrieve information for all content by Channel, including the ID. You can also limit your results based on scheduled status (for example, draft, scheduled, unapproved, or published).

Via the Falcon platform

In Falcon, you can locate the ID of any draft by clicking on the draft to open it in Publish. The ID for your stock item will be visible in the last portion of the URL as shown below:

mceclip0.png

How Can I Use the Publishing API?

You may decide to use the Publishing API in conjunction with an Enterprise Resource Planning (ERP), Content Management System (CMS), or Data Access Management (DAM) tool to automatically generate posts based on specific triggers. For example, when new product visuals are uploaded or when a blog post is published. The integration can automatically generate a new draft and push it to Falcon.

Alternatively, you could create a spreadsheet with each row defining a new draft. Next, create and execute a custom macro to integrate the spreadsheet with Falcon via the Publishing API.

Where Can I Find the Technical Documentation?

For general information and descriptions of the available APIs, check out the Help Center guides here. To view the Falcon API Technical Documentation, please visit: falconio.docs.apiary.io

Was this article helpful?
0 out of 0 found this helpful