Skip to content

Latest commit

 

History

History
182 lines (108 loc) · 4.6 KB

TEMPLATES_API.md

File metadata and controls

182 lines (108 loc) · 4.6 KB

Templates API

No authorization is required for ./templates API's.

For detailed usage please see examples for each method.

Get All Templates

Retrieves all templates.

<?php

require '../../vendor/autoload.php';

$templates = \Renderforest\ApiClient::getAllTemplates();

See get all templates example

Get Templates Categories

Retrieves templates categories.

<?php

require '../../vendor/autoload.php';

$renderforestClient = new \Renderforest\ApiClient(
    'your-api-key',
    'your-client-id'
);

$templateCategories = $renderforestClient->getTemplatesCategories('ru');
  • The supported language codes are: ar, de, en, es, fr, pt, ru, tr.

See get template categories example

Get Template

Retrieves a specific template.

<?php

require '../../vendor/autoload.php';

$template = \Renderforest\ApiClient::getTemplate(701, 'ru');
  • The supported language codes are: ar, de, en, es, fr, pt, ru, tr.

See get specific template example

Get Color-Presets of the Template

Retrieves color-presets of the template. You can apply these color presets to your project to give it better and unique look.

<?php

require '../../vendor/autoload.php';

$templateColorPresets = \Renderforest\ApiClient::getTemplateColorPresets(701);
  • The number of color-presets is varying from template to template.

See get template color presets example

Get Pluggable-Screens of the Template

Retrieves pluggable-screens of the template.

<?php

require '../../vendor/autoload.php';

$templatePluggableScreensGroupCollection = \Renderforest\ApiClient::getTemplatePluggableScreens(701);
  • Only lego templates might have a pluggable-screen.
  • The number of pluggable-screens is varying from template to template. Pluggable-Screens are grouped by categories.

See get pluggable-screens example

Get Recommended-Custom-Colors of the Template

Retrieves recommended-custom-colors of the template. You can apply these recommended custom colors to your project to give it better and unique look.

<?php

require '../../vendor/autoload.php';

$customColors = \Renderforest\ApiClient::getTemplateRecommendedCustomColors(701);
  • The number of recommended-custom-colors is varying from template to template.

See get recommended custom colors example

Get Template-Presets of the Template

Retrieves template-presets of the template.

<?php

require '../../vendor/autoload.php';

$templatePresets = \Renderforest\ApiClient::getTemplatePresets(701);

  • Only lego templates might have a template-preset.

  • The number of template-presets is varying from template to template. Template-presets are ready-made stories created from this template to fasten your video production.

See get template presets example

Get SVG Content of the Template

Retrieves SVG content of the template.



See get template svg content example


Get Theme of the Template


Retrieves theme of the template.


<?php

require '../../vendor/autoload.php';

$templateTheme = \Renderforest\ApiClient::getTemplateTheme(701);


    

  • Both lego & non-lego templates might have a theme.
    • 



See get template them example


Get Transitions of the Template


Retrieves transitions of the template.


<?php

require '../../vendor/autoload.php';

$templateTransitions = \Renderforest\ApiClient::getTemplateTransitions(701);


See get template transitions example


⬆ back to the top