get_app_info (GET)

Purpose

Returns general information about the application.


Input parameters

None


Output data

A JSON object with the following format:

{
   "botize_api_version":"1",
   "functions_count":"2",
   "web":"http://www.example.com/WonderApp",
   "user_auth_mode":"web",
   "texts":{
      "en":{
         "title":"My application",
         "description":"A foobar manager that allows full interaction with fizzbuzzs"
      },
      "es":{
         "title":"Mi aplicación"
         "description":"Gestor de foobars que permite interacción completa con fizzbuzzs"
      }
   },
   "images_path":"images"
}

  • botize_api_version: The Botize API version that the application conforms to. This document explains version 1.
  • functions_count: The total count of functions (triggers and actions) that the application implements.
  • web: The URL of a web site that contains information about the application. This URL will be displayed to the Botize users that use your application functions to create tasks.
  • user_auth_mode: How the user will authenticate to the third-party service with which the application interacts. There are three possible values:
    • "none": The application does not make use of any third-party service, or the service does not require authentication.
    • "credentials": The user must provide a username and a password directly in the task configuration page in the Botize site.
    • "web": An external, web-based provider, usually (but not necessarily) OAuth based authentication provider will be used.
  • texts/XX/title: The human readable title of the application.
  • texts/XX/description: A short description of what the application does.
  • images_path: The path where the images that Botize use to represent the application are placed. There are three possible formats for this element:
    • An empty string, or the element is not included at all: Botize will use the get_image command to retrieve the images.
    • A relative URL (not starting with http:// or https://): Botize will compose the image URL by concatenating the application entry point URL, the value of this element, and the image name.
    • An absolute URL (starting with http:// or https://): Botize will compose the image URL by concatenating the value of this element and the image name.

Notes

When the user authentication mode is “credentials”, Botize will provide user interface for entering a username and a password, and will execute the authenticate_user command in order to validate the credentials.

When the user authentication mode is “web”, Botize will execute the begin_authenticate_user and end_authenticate_user commands instead. Botize itself will take care of redirecting the user to the appropriate third party authentication service page when appropriate.

Your application should provide two PNG icons that represent the application within the Botize site, whose names should be icon32.png and icon48.png (with sizes 32x32 pixels and 48x48 pixels respectively) and which should be accessible via the URL specified in images_path. Alternatively, images_path could be missing or empty, in which case Botize will use the get_image command to retrieve the images.