You are here

Home » API reference » API Tokens 8

README.txt in API Tokens 8

Same filename and directory in other branches
  1. 8.2 README.txt
  2. 7 README.txt
-- SUMMARY --

The API Tokens module provides an input filter that allows to replace custom
parametric tokens (API tokens) with rendered content. To register an API token
define an "ApiToken" plugin.

For example, you can define a token which will render a current date as follows:
  [api:date/],
or render blocks:
  [api:block["block_id"]/],
or nodes:
  [api:node[123, "teaser"]/].

Note that API Tokens module does not provide any visible functions to the user
on its own, it just provides handling services for other modules. See
api_tokens_example module for example implementations.

To disable caching of dynamic API tokens for anonymous users disable "Internal
Page Cache" (page_cache) core module.


For a full description of the module, visit the project page:
  http://drupal.org/project/api_tokens

To submit bug reports and feature suggestions, or to track changes:
  http://drupal.org/project/issues/api_tokens


-- REQUIREMENTS --

Filter.


-- INSTALLATION --

* Install as usual, see http://drupal.org/docs/8/extending-drupal-8 for
  further information.


-- CONFIGURATION --

* Go to /admin/config/content/formats and enable the API Tokens filter for any
  of your existing text formats or create a new one.

* List of all registered tokens available at admin/config/content/api-tokens.


-- CONTACT --

Current maintainers:
* Alex Zhulin - https://drupal.org/user/2659881

File

README.txt
View source 
  1. -- SUMMARY --

  2. 

  3. The API Tokens module provides an input filter that allows to replace custom

  4. parametric tokens (API tokens) with rendered content. To register an API token

  5. define an "ApiToken" plugin.

  6. 

  7. For example, you can define a token which will render a current date as follows:

  8.   [api:date/],

  9. or render blocks:

  10.   [api:block["block_id"]/],

  11. or nodes:

  12.   [api:node[123, "teaser"]/].

  13. 

  14. Note that API Tokens module does not provide any visible functions to the user

  15. on its own, it just provides handling services for other modules. See

  16. api_tokens_example module for example implementations.

  17. 

  18. To disable caching of dynamic API tokens for anonymous users disable "Internal

  19. Page Cache" (page_cache) core module.

  20. 

  21. 

  22. For a full description of the module, visit the project page:

  23.   http://drupal.org/project/api_tokens

  24. 

  25. To submit bug reports and feature suggestions, or to track changes:

  26.   http://drupal.org/project/issues/api_tokens

  27. 

  28. 

  29. -- REQUIREMENTS --

  30. 

  31. Filter.

  32. 

  33. 

  34. -- INSTALLATION --

  35. 

  36. * Install as usual, see http://drupal.org/docs/8/extending-drupal-8 for

  37.   further information.

  38. 

  39. 

  40. -- CONFIGURATION --

  41. 

  42. * Go to /admin/config/content/formats and enable the API Tokens filter for any

  43.   of your existing text formats or create a new one.

  44. 

  45. * List of all registered tokens available at admin/config/content/api-tokens.

  46. 

  47. 

  48. -- CONTACT --

  49. 

  50. Current maintainers:

  51. * Alex Zhulin - https://drupal.org/user/2659881