Skip to content
Laravel

Vue Plugin

Introduction

The OTAS plugin, developed with Vue.js, functions as a plugin for WordPress. Once installed and configured within WordPress, it allows for the embedding of components on pages through the use of shortcodes.

Configuration

  • API Key: To obtain an API key, navigate to the Settings/API Clients section on https://otas.oktamam.info/dashboard/api-clients. Select the OTAS Plugin type for your key. Once generated, enter this key into the OTAS settings page within WordPress.
  • API Base URL: This is the root URL of the OTAS system (for example, https://otas.oktamam.info). Ensure not to include a trailing slash at the end of the URL.
  • Show/Hide Visit School Button: This checkbox allows you to toggle the visibility of the "Visit School" button within the program listings.
  • Apply Button's URL (Leave empty if default): Specify a custom URL for the apply button to direct submissions through the plugin; leave blank to use the default action.
  • Affiliate Login URL: This URL is designated for affiliate users to log in and monitor the performance of their affiliate code.
  • Affiliate Registration URL: Use this URL for new users to register as affiliates and obtain an affiliate code for enrolling students.
  • Apply Short URL (Language Name): Enter a custom URL or a language code as part of the URL for a specific language version of the application page; leave blank if not required.
  • Success URL {Language Code}: Specify a custom success page URL for post-application submission in a particular language; leave blank if not necessary.

ShortCodes

The plugin provides shortcodes to embed components within a WordPress page. Below is a list of available shortcodes:

otas otas-checker quick-filters programs-table affiliate-registration affiliate-login site:search-input site:programs-cards site:apply-form site:side-filters site:done

otas

The shortcode [otas] corresponds to the primary component that showcases a list of programs with pagination, utilizing the older style of program cards. This approach is now deprecated in favor of the new shortcode [site:programs-cards], which is used to display program information in a modern card format.

otas-checker

The shortcode [otas-checker] denotes a component designed for checking applications by inputting a passport number and birthday. It retrieves all applications associated with a student and allows for viewing these applications sorted by their statuses.

quick-filters

The shortcode [quick-filters] is associated with filters that allow users to sort programs based on criteria such as countries, institutions, levels, languages, etc. This shortcode has been deprecated and replaced by [site:side-filters] for enhanced filtering capabilities.

programs-table

The shortcode [programs-table] displays programs in a tabular format.

affiliate-registration

The shortcode [affiliate-registration] embeds a registration form specifically for affiliate users.

affiliate-login

The shortcode [affiliate-login] embeds a login form designed for affiliate users.

site:search-input

The shortcode [site:search-input] represents a modern-styled search form that enables users to search for programs by criteria such as countries, institutions, levels, languages, etc.

site:programs-cards

The shortcode [site:programs-cards] displays a list of programs in a contemporary card layout, showcasing the new style.

site:apply-form

The shortcode [site:apply-form] embeds an application form, allowing students to enter their information to submit an application.

site:side-filters

The shortcode [site:side-filters] embeds a filter form that enables users to refine program listings by criteria such as countries, institutions, levels, languages, etc.

site:done

The shortcode [site:done] displays a completion page that appears once a student submits their application.