Twake public developers API v1

Paramétrer mon application

Une fois sur la page d'édition de votre application, vous pouvez configurer votre application, pour commencer pensez à renseigner une description et une icône à votre application, ce sera bien plus joli ! ✨

La première chose qui vient ensuite sont les paramètres d'API. Vous y trouverez deux informations importantes :

• Votre clé API privée
• Votre identifiant publique d'application

Ces deux valeurs vous permettront d'effectuer des appels sur l'API Twake.

Avant de continuez vous devez renseigner deux autres champs :

• Une URL qui vous servira à recevoir les évènements destinés à votre application
• Une liste des adresse IP qui ont le droit d'appeler l'API Twake avec vos identifiants, vous pouvez utiliser ***** pendant le développement de votre application.

Configuration de l'affichage de l'application

Pour configurer les endroits où votre application doit s'afficher, vous devez renseigner un objet JSON dans le champ sous Paramètres d'affichage. Voici un exemple complet de la configuration d'affichage. Chaque champ est optionnel et sa présence détermine le positionnement de votre application dans Twake.

{
  "tasks_module" : {
    "can_connect_to_tasks": true
	},
  "calendar_module" : {
    "can_connect_to_calendar": true
	}
	"drive_module" : {
    "can_connect_to_directory": true,
    "can_open_files": {
			"url": "", //Une url à appeler pour éditer le fichier (ouvert dans un onglet)
			"preview_url": "", //Une url à appeler pour prévisualiser un fichier (iframe)
			"main_ext": ["docx", "xlsx"], //Extensions principales
			"other_ext": ["txt", "html"] //Extensions secondaires
		},
		"can_create_files": [
			{
				"url": "https://[...]/empty.docx",
				"filename": "Untitled.docx",
				"name": "Word Document"
			},
      {
				"url": "https://[...]/empty.xlsx",
				"filename": "Untitled.xlsx",
				"name": "Excel Document"
			}
		]
  },
  "member_app": true, // Si défini, votre application génèrera un membre
                      // virtuel dans l'espace de travail avec lequel les
                      // utilisateurs pourront discuter.
  "messages_module": {
    "in_plus": {
      "should_wait_for_popup": true
    },
    "right_icon": {
			"icon_url": "", //If defined replace original icon url of your app 
      "should_wait_for_popup": true
    },
    "action": {
      "should_wait_for_popup": true,
      "description": "fdsqfds" //Description de l'action, sinon remplacé par le nom de l'app
    },
    "commands": [
			{
				"command": "mycommand", // my_app mycommand
        "description": "fdsqfds"
			}
		]
  },
  "channel": {
    "can_connect_to_channel": ""
  },
  "channel_tab": {
    "iframe": ""
  },
  "app": {
    "iframe": "",
    "plus_btn": {
      "should_wait_for_popup": true
    }
  },
  "configuration": {
    "can_configure_in_workspace": true,
    "can_configure_in_channel": true,
		"can_configure_in_calendar": true,
		"can_configure_in_tasks": true,
    //"can_configure_in_directory": true
  }
}

Configuration des accès et privilèges de l'application

Votre application peut accéder à des données et modifier des données, seulement en fonction de vos besoin vous n'avez pas besoin d'accéder à toutes les données présentes dans Twake. C'est pourquoi vous devez préciser les accès nécessaires au bon fonctionnement de votre application. Ces accès seront publique et indiqués à l'utilisateur avant l'installation de votre application.

Information sur la publication