REST interface

<< Click to display Table of Contents >>

Navigation:  Components > Authentication Server > Configuration > Settings for token distribution (self-hosted) >

REST interface

In this chapter, you will learn how to configure the token dispatch via the REST interface.

 

 

To use it, you need a system that responds to REST requests.

 

Tokens are necessary for the use of the Cordaware bestzero® Appsbox. Besides sending the token e.g. via email, it is possible to send a POST request.

 

For the setup of the REST-API interface and the associated POST request, the following steps are required:

 

hmtoggle_arrow11. best_local.ini (/best_srv/etc/)

 

 

[best_ext]
token_by_post = true (Default: false)

 

Thus the following function with return value can be used in the script for the token dispatch. The value here is "post".

 

 

best_script:user_token_sendby() -> post

 

The following setting can be used to adjust the validity period of a sent token.

 

 

[best_ext]
token_by_post_lifetime = 30 (Default: 10)

 

In our example, the validity period was increased to 30 days. Normally this is only valid for 10 days.

 

 

 

hmtoggle_arrow12. Info2Mail Filter (Web Interface)

By default, a script is stored that ensures the token dispatch via e-mail. The script for this can be found in the corresponding chapter.

In the following you find a short instruction, where the script is to be found and at which places it must be adapted.

 

1. Log in to the Cordaware bestzero® web interface.

 

register_en_1

 

2. Open the Filter App in the Cordaware bestzero® web interface

 

sms-rest_2

 

3. Click on the grey filter "bestzero token sending" with the type "Info2Mail" and press the "E" key on your keyboard

 

sms-rest_3

 

4. Now replace the existing script with this script. Please make sure the you insert your server data.

 

 

% Cordaware bestzero token mail script

-module(best_home_mail).

-export([main/1]).

 

%% Please set the REST server here

bi_server() -> "https://myserver.cordaware.local/create_data".

bi_method() -> post.

 

%% Message, which is passed via the JSON parameter "msg"

bi_info(Token) ->

  <<"Hello<br/><br/>\r\n",

  "Your registration token to enter the Cordaware bestzero Appsbox is:<br/><br/><b> ", Token/binary, "</b><br/><br/>\r\n",

  "We wish much fun<br/>\r\n",

  "Cordaware bestzero">>.

 

%% From here on please do not adjust anything

 

main(_Doc) ->

  MailTo = [binary_to_list(best_script:user_email())],

  Token = best_script:user_token(),

  Info = bi_info(Token),

  %best_script:debug_msg("Sending bestzero Token to: ~p (token is ~p, timestamp is ~p)", [MailTo, Token, now()]),

  bi_letter(Info, Token)

  true.

 

bi_letter(Message, PostToken) ->

  Json = best_script:json_encode({[{<<"msg">>, Message},{<<"token">>, PostToken}]}),

  best_script:httprequest(bi_method(),

  {bi_server(), [],

    "application/json", Json

  }, [], []).

 

5. Please save the filter after you completed your adjustments to save the changes. Your users will now receive their token via the REST interface.

 

rest_4

 

 

 

If you want to make further adjustments to the script, our support will be there to assist you.

Contact us via email at support@cordaware.com, phone at +49 (0) 8441 8593 200 or use our Customer Portal.