What is Vev Content API?
Our Content API enables our users to (programmatically) access and push content, such as text, images, etc. from any CMS to Vev.
Why should I use Vev’s Content API?
In this section, we'll explore some of the key ways that Content API can impact your workflow, and provide guidance on how to get the most out of this powerful technology.
Streamlined Content Management
With a Content API, you no longer need to manually create and upload content to your Design Editor. Instead, you push your content from any CMS to Vev and display your content in the Design Editor. This can help streamline your content management process between your Designer and Copywriter and save you time and effort.
Starting from template
Design your template e.g. for your landing page or microsite and select the elements that you want to be dynamic and populate your assets from your CMS. Add your last animations and publish! It’s a new way of working between Content API and Design Editor.
Improve your SEO
Vev Content API can also help improve your SEO by ensuring that your content is well-organized and easy to find. By providing structured data to search engines, your website can be more easily indexed and ranked, leading to more traffic and better visibility.
By using a Content API, web page builders can ensure that content is consistent and up-to-date across all pages and platforms. This can help to improve user experience and reduce the risk of errors or inconsistencies in the content.
When should I use Vev’s Content API?
Consider using the Content API, if you
have a CMS in your tech stack and do not want to copy-paste from the CMS to Vev
create recurring Vev content (e.g. landing pages, long-read pages, etc.)
want to automate your publishing process with Vev
How do I set up the Vev Content API?
To use the Content API, follow these steps:
Create a template in Vev
In the Template Editor, design your template for the Vev content you want to publish.
Make your elements dynamic by adding them to the schema
After designing your template, add your text and images to the schema to make them dynamic.
To do this, switch to the “API” tab in the bottom left corner:
Note that in the “API” mode, the top style bar is unavailable, and the right panel is reserved for the schema. You can't add or edit any style in the “API” tab.
In the API tab, determine which textboxes, images, etc. you want to make dynamic.
You'll need to determine keys for each section, and then for all the elements in that section.
Double-click or use the button in the right panel to add textboxes and images to the schema.
Once you've finished adding elements to the schema, copy the entire schema.
For further information on this process step, check out our technical documentation at https://developer.vev.design/docs/api/content-api/content-api-template
Use the Vev API key to authenticate with your CMS
To authenticate your CMS with Vev, you will need to use an API key. Here's how to create and use your API key:
Go to your profile settings in Vev
Create a new API key and make sure to select the "createProject" scope.
Give your API key a unique name for easy identification purposes.
Once your API key is created, copy it immediately as it will only be displayed once.
Paste the API key into your CMS platform.
Push your content from your CMS to Vev as described in the developer documentation
Please go through our technical documentation on how to push your content from your CMS to Vev: https://developer.vev.design/docs/category/content-api
Do your last edits in the Design Editor in Vev
Now the content part is set up, the Designer can pick up from here and can finish the design work.
What happens when I update my content in the CMS after I publish it? What do I need to do?
Your changes will be reflected in Vev once you push to Vev. You have to republish in Vev to make your changes effective.
Can I update my content in Vev as well?
Yes, you can update and make your last changes before you publish in Vev. If your text boxes and images are connected to your CMS and you update your e.g. images, those changes will be overridden in Vev as well.
Text boxes and images that are not connected to your CMS have no impact on your updates from your CMS.
If you use the Content API, we recommend changing the content always in your CMS (as that is your golden source).
Will any other features be deprecated when introducing the Vev Content API?
No, everything in Vev will remain as is! Content API is an additional feature if you want to automate your publishing process.