All Collections
Plugin Questions
Helpers
(Plugin) How to access Stripo’s public templates via API?
(Plugin) How to access Stripo’s public templates via API?

This article provides instructions on how to access Stripo's templates.

Kyrylo avatar
Written by Kyrylo
Updated over a week ago

If you have already made your own plugin application, you can gain access to the Stripo platform's template library.

Depending on the plan, you can get the following templates:

  • FREE plan - only basic templates;

  • STARTUP - basic and templates that marked as FREE;

  • BUSINESS and ENTERPRISE - basic, free and PREMIUM templates.

After you perform the first request to get the array of needed templates, you have to make a sequence of separate calls for each template to get its HTML and CSS, as described in the GET TEMPLATE method below.


GET TEMPLATES METHOD:

This method returns an array of templates that match the specified search criteria, including their metadata, but excluding the HTML and CSS code:

GET: /v1/templates
Host: https://my.stripo.email/bapi/plugin-templates
Header: ES-PLUGIN-AUTH: Bearer YOUR_AUTH_TOKEN
query params:
type (BASIC | FREE | PREMIUM)
sort (NEW | ACTUAL)
limit (int)
page (int)
templateTypes (array of integer, example: &templateTypes=1&templateTypes=2)
templateSeasons (array of integer, example: &templateSeasons=1&templateSeasons=2)
templateFeatures (array of integer, example: &templateFeatures=1&templateFeatures=2)
templateIndustries (array of integer, example: &templateIndustries=1&templateIndustries=2)
response: {
total: int,
data: {
templateId: int;
name: string;
logo: string;
premium: boolean;
hasAmp: boolean;
updatedAt: long;
createdTime: long;
templateTypes: {id: int, name: string}[];
templateSeasons: {id: int, name: string}[];
templateFeatures: {id: int, name: string}[];
templateIndustries: {id: int, name: string}[];
}[];
}


​Please find below the descriptions of the parameters:

type

This is the mandatory parameter and specifies the variety of templates that should be returned. Possible values are as follows: BASIC, FREE, or PREMIUM

sort

Optional parameter that defines how the templates are sorted in response. This parameter has 2 values:

  • NEW - templates will be sorted by creation date.

  • ACTUAL (default one) - templates will be sorted depending on seasonal events that are relevant to the date of the request.

limit

Optional parameter that regulates how many items should be returned per the page. We suggest specifying the limit of no more than 50 entities, as the speed of response to the request depends on this

page

Optional parameter that defines the number of the page

templateTypes

Make use of the optional parameter to filter templates that specifically pertain to relevant categories. For a complete catalog of possible categories within this context, please utilize the GET TEMPLATE TYPES method.

templateSeasons - templates array sorted by season events

Utilize the optional parameter to restrict the selection of templates to those associated with seasonal events categories. For a comprehensive listing of potential categories related to this topic, kindly employ the GET TEMPLATE SEASONS method.

templateFeatures

Use the optional parameter to ensure that only templates related to specific feature categories are retrieved. To access the full array of potential categories under this classification, kindly employ the GET TEMPLATE FEATURES method.

templateIndustries

Apply the optional parameter to narrow down your template selection to include only those featuring industry-specific categories. For an exhaustive list of potential categories within this field, please use the GET TEMPLATE INDUSTRIES method.


Bearer is an important token that you need to pass when downloading templates.
This parameter allows the system to analyze your plugin data in order to download suitable templates for you.

To get this token, you just need to go to your plugin template, make any changes, and save it. In the "Network" -> "Es-Plugin-Auth" section, you will find this token.

Let's consider an example of my GET templates request:

https://my.stripo.email/bapi/plugin-templates/v1/templates?type=FREE&limit=666&sort=NEW&page=0

GET TEMPLATE METHOD:

This method returns the metadata, as well as the HTML and CSS code, for a specific template specified by its ID:

GET: /v1/templates/{templateId}
Host: https://my.stripo.email/bapi/plugin-templates
Header: ES-PLUGIN-AUTH: Bearer YOUR_AUTH_TOKEN
response: {
templateId: int;
name: string;
logo: string;
premium: boolean;
hasAmp: boolean;
updatedAt: long;
createdTime: long;
templateTypes: {id: int, name: string}[];
templateSeasons: {id: int, name: string}[];
templateFeatures: {id: int, name: string}[];
templateIndustries: {id: int, name: string}[];
html: string;
css: string;
}


​An example of my GET template request:


https://my.stripo.email/bapi/plugin-templates/v1/templates/111111



Also, you can get an array of the available values for the template divided by types, seasons, features, and industries.


GET TEMPLATE TYPES:

This method returns an array of the available values for the templateTypes parameter.

GET: /v1/templates/types
Host: https://my.stripo.email/bapi/plugin-templates
Header: ES-PLUGIN-AUTH: Bearer YOUR_AUTH_TOKEN
response: {id: int, name: string}[];



GET TEMPLATE SEASONS:

This method returns an array of the available values for the templateSeasons parameter.

GET: /v1/templates/seasons
Host: https://my.stripo.email/bapi/plugin-templates
Header: ES-PLUGIN-AUTH: Bearer YOUR_AUTH_TOKEN
response: {id: int, name: string}[];


GET TEMPLATE FEATURES:

This method returns an array of the available values for the templateFeatures parameter.

GET: /v1/templates/features
Host: https://my.stripo.email/bapi/plugin-templates
Header: ES-PLUGIN-AUTH: Bearer YOUR_AUTH_TOKEN
response: {id: int, name: string}[];


GET TEMPLATE INDUSTRIES:

This method returns an array of the available values for the templateIndustries parameter.

GET: /v1/templates/industries
Host: https://my.stripo.email/bapi/plugin-templates
Header: ES-PLUGIN-AUTH: Bearer YOUR_AUTH_TOKEN
response: {id: int, name: string}[];




Thank you for taking the time to read our articles. We hope you will find this information helpful.


If you have any additional questions, please email us at support@stripo.email.

We would be glad to talk with you.


Did this answer your question?