Outbound Feeds Environments
Outbound Feeds is provisioned into two environments: outboundfeeds and outboundfeeds-sandbox. Each environment contains an Outbound Feed Editor, PB Data, Global Settings, Permissions, and Developer Center titles. By running as separate fusion instances in their own environments, you can make changes to outboundfeeds without impacting your production website. The Outbound Feeds environments are intended to serve feeds and are restricted to text-only output: xml, json, txt. They also can not reference any /pf/* assets.
Outbound Feeds
The Outbound Feeds (OBF) environment is configured as your production feeds environment. It runs in its fusion environment independent of your website. A rule has been added to your origin that sends all requests that start /arc/outboundfeeds/ to the OBF instance. All OBF page URIs and resolver REGEXs must start with /arc/outboundfeeds/. It gets its data from the production Content-API and calls made by Outbound Feeds are included in your Content-API rate limit.
In each feed, each link is given a fully qualified URL using that website’s domain (https://www.example.com). The domain comes from your blocks.json file, in the siteProperties field feedDomainURL for each website. This should be your production domain so that when the links are followed, they return valid results. If your website has not gone live on Arc yet, you can use your test production domain https://ORG-WEBSITE-prod.web.arc-cdn.net until your site goes live.
If you are doing local OBF development, you need to use a Developer Center token generated in your production environment for your .env file (The same token you use with your local version of your website) needed by your local outboundfeeds repo. When encrypting secret values be sure to do it in this environment https://outboundfeeds.ORG.arcpublishing.com/deployments/fusion/secrets as each fusion environment has its encryption key.
The Outbound Feeds environment has its own Developer Center tile. This should only be used to generate tokens to call the Outbound Feeds deployer API https://api.outboundfeeds.ORG.arcpublishing.com/deployments/fusion/bundles used with CI/CD.
You can access your production feeds two different ways. You can access the internal URL which goes directly to the OBF instance once you have signed into your OKTA dashboard.
- Internal URL -
https://outboundfeeds.ORG.arcpublishing.com/pf/arc/outboundfeeds/FEED?outputType=xml&\_website=WEBSITE - Public URL -
https://www.example.com/arc/outboundfeeds/FEED?outputType=xmlYour OBF environment is pre-configured with the following feeds. (the link examples assume you have set default outputTypes on all resolvers)
A Postman collection has been created that contains each feed. You can find it Here.
Most feed resolvers are configured to allow filtering results by section, author, seo_keywords, tags, and tag_slugs.
| Feed | URL |
|---|---|
| section - taxonomy.section _id | https://www.example.com/arc/outboundfeeds/sitemap/category/news,politics/ |
| author - credits.by._id | https://www.example.com/arc/outboundfeeds/sitemap/author/john.smith/ |
| keyword - taxonomy.seo_keywords | https://www.example.com/arc/outboundfeeds/sitemap/keyword/sports,football/ |
| tags - taxonomy.tags.text | https://www.example.com/arc/outboundfeeds/sitemap/tags/apples,oranges/ |
| slugs - taxonomy.tags.slug | https://www.example.com/arc/outboundfeeds/sitemap/tags_slug/washington-football-team/ |
Outbound Feeds Sandbox
The Outbound Feeds Sandbox environment is configured as your development feeds environment. It runs in its own fusion environment independent of your website. A rule has been added to your sandbox origin that sends all requests that start /arc/outboundfeeds/ to the OBF-sandbox instance. All OBF page URIs and resolver REGEXs need to start with /arc/outboundfeeds/. It gets its data from the sandbox Content-API and calls made by OBF-sandbox are included in your sandbox Content-API rate limit. If your sandbox environment does not have recently published data, you might not see any content in your sandbox feeds. You can update your sandbox resolvers to not use a date range by setting a static Include-Terms like
[{"term":{"type": "story"}}]In each feed, each link is given a fully qualified url using that website’s domain (https://www.example.com). The domain used comes from your blocks.json in the siteProperties field feedDomainURL for each website. Since there is only one value per website in blocks.json, you must decide how to handle sandbox URLs. If you use the production domain, the links will not be valid since it will attempt to request sandbox content from your production system. If you want to use the sandbox domain, you must develop a process to change the blocks.json between sandbox and prod deploys.
If you are doing local Outbound Feeds development, you need to use a Developer Center token generated in your sandbox environment for your .env file in your outboundfeeds repo. When encrypting secret values be sure to do it in this environment https://outboundfeeds-sandbox.ORG.arcpublishing.com/deployments/fusion/secretsas each fusion environment has it’s encryption key.
The Outbound Feeds environment has its Developer Center tile. This should only be used to generate tokens to call the Outbound Feeds deployer API https://api.outboundfeeds-sandbox.ORG.arcpublishing.com/deployments/fusion/bundles used with CI/CD.
You can access your sandbox feeds in two different ways. You can access the internal URL which goes directly to the OBF instance once you have signed into your OKTA dashboard.
- Internal URL -
https://outboundfeeds-sandbox.ORG.arcpublishing.com/pf/arc/outboundfeeds/FEED?outputType=xml&_website=WEBSITE - Public URL -
https://ORG-WEBSITE-sandbox.web.arc-cdn.net/arc/outboundfeeds/FEED/?outputType=xml
Your OBF-sandbox environment is pre-configured with the following feeds. (This assumes you have set default outputTypes on all resolvers).