Let's start with the tools and frameworks available for developing on and modifying the PeopleVine platform. In order to develop on PeopleVine, you just need to have coded HTML, nothing more.
These tools give you access to manage and interact with PeopleVine experiences.
- Control Panel - used to configure the platform, run reports, setup automation, manage your customers, etc., it puts you in control.
- Portal - this is the consumer facing view of what you create, whether it be a content page, an event or managing their account.
https://portal.peoplevine.com (or your domain name)
- Studio - for developers looking for a real-time preview of their edits, they can utilize Studio to one-click save and preview.
- Builder - the builder is a drag and drop interface for building content pages and newsletters. It also has an HTML editor and other tools to give you complete control over your content.
https://control.peoplevine.com/pages or https://control.peoplevine.com/newsletters then click on Launch in Builder
You have complete control over the user experience when leveraging these frameworks.
- Layouts - Every domain name and landing page in PeopleVine can be assigned a layout. The layout is designed to wrap the content with your branding, your logo, your styles and to ensure your site is consistent no matter how people engage.
- Templates - Build your own drag and drop snippets that your marketing team can easily add within the Builder.
- Keyword Pages - Throughout the platform, we have created the ability to leverage the marketing keyword to replace a page with your custom HAPI based page.
- API - Our most robust API and the same API we used to build the Control Panel and Portal. Contains access to CRUD across every component.
- RESTful API - Staying on par with the latest in technology, we have released our RESTful API to accommodate mainly app based interactions.
Getting Your Credentials
There are a few ways to start developing and access data stored in PeopleVine.
No Keys Needed
With HAPI, we utilize the domain name it runs on and the customer/business accessing the data in order to display relevant data to the user. This is the most secured method for developing on PeopleVine and requires no additional authentication keys.
- API Credentials - These are used to authenticate your API application to the PeopleVine platform. You should have separate keys for each app you create.
- API Application - You will need to then setup an API application to generate your api_key.
- User Account - in order for the API to access data, we need to know what user it's for or you can setup a new user as API Access Only to finalize the AUTH keys.