[tomglod]

Hello Appli Users,

Launching Appli Connect was a significant milestone on our development roadmap.
However, it is a feature that is never finished, and will require support and communication with all of you.
Over the coming weeks we will round out the interface, training and documentation of this feature.

The purpose of Appli Connect is to help your apps to be able to communicate with any and all web api's and endpoints. Without limits.
In creating this feature we sought to create a flexible system that will allow us, AND our users to build Appli Connect endpoints and connections.

Introducing the Appli Connect Endpoint Definition Script:

Example Definition:

Code:

// PROVIDER: EXAMPLE API PROVIDER
//*******************************

// PROVIDER INFO
put "ExampleAPI" into tProvider  -- NAME OF API PROVIDER
put "https://appli-public.nyc3.cdn.digitaloceanspaces.com/vendor-logos/ExampleAPI-Logo.png" into gAppliConnectA[tProvider]["Provider Meta"]["Provider Logo"] -- LINK TO PROVIDER LOGO
put "https://exampleapi.com/docs" into gAppliConnectA[tProvider]["Provider Meta"]["Developer Documentation URL"]  -- LINK TO DEVELOPER DOCUMENTATION


// ENDPOINT: GET EXAMPLE DATA
//***************************

put "ExampleAPI Get Data" into tName -- UNIQUE NAME OF THE ENDPOINT

// DEFINE ENDPOINT
put "https://api.exampleapi.com/data" into tEndpoint -- BASE URL FOR THE ENDPOINT
put "https://api.exampleapi.com/data/{VariableName}" into tEndpoint -- BASE URL FOR ENDPOINTS WHICH INCLUDES VARIABLES IN THE ENDPOINT

put tName into gAppliConnectA[tProvider]["Endpoints"][tName]["name"] -- STORE ENDPOINT NAME

// ENDPOINT SETTINGS
put "This endpoint retrieves example data from ExampleAPI." into gAppliConnectA[tProvider]["Endpoints"][tName]["Description"] -- SIMPLE DESCRIPTION OF WHAT THE ENDPOINT'S PURPOSE
put "GET" into gAppliConnectA[tProvider]["Endpoints"][tName]["method"] -- HTTP METHOD OF THE ENDPOINT
put tEndpoint into gAppliConnectA[tProvider]["Endpoints"][tName]["base url"] -- STORE BASE URL

// IS THIS AN OAUTH PROVIDER ENDPOINT?
put "false" into gAppliConnectA[tProvider]["Endpoints"][tName]["is oAuth2"] -- IS ENDPOINT FOR OAUTH ACCESS TOKEN RETRIEVAL
put "https://www.dropbox.com/oauth2/authorize" into gAppliConnectA[tProvider]["Endpoints"][tName]["oAuth Authorize URL"] -- IS THE URL OF AUTHORIZING THE OAUTH USER WITH THEIR LOGIN

// ENDPOINT URL VARIABLES
put "variable1,variable2" into gAppliConnectA[tProvider]["Endpoints"][tName]["request"]["endpoint variables"] -- COMMA DELIMITED LIST OF REQUIRED URL VARIABLES
put "Description of variable1,Description of variable2" into gAppliConnectA[tProvider]["Endpoints"][tName]["request"]["endpoint variables desc"] -- COMMA DELIMITED SHORT DESCRIPTION OF EACH URL VARIABLE

// REQUIRED HEADERS & DESCRIPTION
put "header1,header2" into gAppliConnectA[tProvider]["Endpoints"][tName]["request"]["required header keys"] -- COMMA DELIMITED LIST OF REQUIRED HEADERS
put "Description of header1,Description of header2" into gAppliConnectA[tProvider]["Endpoints"][tName]["request"]["required header keys desc"] -- COMMA DELIMITED SHORT DESCRIPTION OF EACH REQUIRED HEADER

// OPTIONAL HEADERS & DESCRIPTION
put "optionalHeader1,optionalHeader2" into gAppliConnectA[tProvider]["Endpoints"][tName]["request"]["optional header keys"] -- COMMA DELIMITED LIST OF OPTIONAL HEADERS
put "Description of optionalHeader1,Description of optionalHeader2" into gAppliConnectA[tProvider]["Endpoints"][tName]["request"]["optional header keys desc"] -- COMMA DELIMITED SHORT DESCRIPTION OF EACH OPTIONAL HEADER

// REQUEST DEFINITION
// REQUIRED URL PARAMS & DESCRIPTION
put "param1,param2" into gAppliConnectA[tProvider]["Endpoints"][tName]["request"]["required URL params"] -- COMMA DELIMITED LIST OF REQUIRED URL PARAMETERS
put "Description of param1,Description of param2" into gAppliConnectA[tProvider]["Endpoints"][tName]["request"]["required URL params desc"] -- COMMA DELIMITED SHORT DESCRIPTION OF EACH REQUIRED URL PARAMETER

// OPTIONAL URL PARAMS & DESCRIPTION
put "optionalParam1,optionalParam2" into gAppliConnectA[tProvider]["Endpoints"][tName]["request"]["optional URL params"] -- COMMA DELIMITED LIST OF OPTIONAL URL PARAMETERS
put "Description of optionalParam1,Description of optionalParam2" into gAppliConnectA[tProvider]["Endpoints"][tName]["request"]["optional URL params desc"] -- COMMA DELIMITED SHORT DESCRIPTION OF EACH OPTIONAL URL PARAMETER

// REQUIRED JSON BODY KEYS & DESCRIPTION
put "jsonKey1,jsonKey2" into gAppliConnectA[tProvider]["Endpoints"][tName]["request"]["required JSON body"] -- COMMA DELIMITED LIST OF REQUIRED JSON BODY KEYS
put "Description of jsonKey1,Description of jsonKey2" into gAppliConnectA[tProvider]["Endpoints"][tName]["request"]["required JSON body desc"] -- COMMA DELIMITED SHORT DESCRIPTION OF EACH REQUIRED JSON BODY KEY

// OPTIONAL JSON BODY KEYS & DESCRIPTION
put "optionalJsonKey1,optionalJsonKey2" into gAppliConnectA[tProvider]["Endpoints"][tName]["request"]["optional JSON body"] -- COMMA DELIMITED LIST OF OPTIONAL JSON BODY KEYS
put "Description of optionalJsonKey1,Description of optionalJsonKey2" into gAppliConnectA[tProvider]["Endpoints"][tName]["request"]["optional JSON body desc"] -- COMMA DELIMITED SHORT DESCRIPTION OF EACH OPTIONAL JSON BODY KEY

// POSSIBLE PREREQUISISTE ENDPOINTS
put "" into gAppliConnectA[tProvider]["Endpoints"][tName]["request"]["prerequisite endpoints"] -- COMMA DELIMITED LIST OF ENDPOINTS THAT MUST RUN BEFORE THIS WILL BE SUCCESSFUL (e.g., AUTHENTICATE, CREATE SESSION)
put "" into gAppliConnectA[tProvider]["Endpoints"][tName]["request"]["prerequisite endpoints desc"] -- COMMA DELIMITED SHORT DESCRIPTION OF EACH PREREQUISITE ENDPOINT

// DEFINE SUCCESSFUL RESPONSES
put 200 into gAppliConnectA[tProvider]["Endpoints"][tName]["success"]["code"] -- THE CODE EQUIVALENT TO A SUCCESSFUL CALL
put "data,total" into gAppliConnectA[tProvider]["Endpoints"][tName]["success"]["keys"] -- THE KEYS THAT COME BACK WITH A SUCCESSFUL REQUEST
put "array,int" into gAppliConnectA[tProvider]["Endpoints"][tName]["success"]["key types"] -- THE TYPES OF EACH RETURNED KEY
put "/" into gAppliConnectA[tProvider]["Endpoints"][tName]["success"]["path to returned data"] -- THE PATH TO REACH THE DATA THE USER WANTS

// SPECIAL KEYS
   
put "Authorization" into gAppliConnectA[tProvider]["Endpoints"][tName]["request"]["bearer tokens"] -- SIGNIFIES WHICH KEY(s) NEEDS THE "bearer" KEYWORD PRIOR TO IT
put "application/octet-stream" into gAppliConnectA[tProvider]["Endpoints"][tName]["default Content-Type"] -- SET THIS AS DEFAULT CONTENT-TYPE WHEN FIRST CONFIGURING THE CONNECTION
put false into gAppliConnectA[tProvider]["Endpoints"][tName]["handles files"] ## DOES THIS ENDPOINT UPLOAD OR DOWNLOAD "FILES" INSTEAD OF DATA TO/FROM VARIABLES

Our dev team will create and add new definitions on a regular basis but we wanted to set you free so you too can create them and use them with the appli Connect input method.

The easiest way to create one is to use our GPT https://chatgpt.com/g/g-IvA7mBjg1-appli-...tion-maker and paste in a link for the documentation of the endpoint that you need. (a free OpenAI account is sufficient)

GPTs are not perfect, but they will get you started in correctly defining any Appli Connect connection, but sometimes the definitions work out of the box.  We will improve the training of the GPT as we learn more about where it makes mistakes.


Important Notes:

• * The 'provider' details needs to be defined only with one of your endpoints, if you have multiple endpoints from the same provider. The GPT will include provider details each time.
  
• * The definitions you add to Appli Connect end up in the provider & endpoint dropdowns, so use a unique provider  & endpoint name to make sure you don't replace existing connections.
  
• * If you are adding an endpoint for an exiting provider, just make sure the provider name matches in each endpoint definition.
  

Do not hesitate to ask us for help in this forum.

Have fun with Appli Connect.... and please share with us how you plan to use Appli Connect to expand your apps' horizons.