Joget DX Beta Available for Download

Check out Joget DX, the next generation successor to Joget Workflow for faster, simpler digital transformation.

Skip to end of metadata
Go to start of metadata

NameDescription

API ID

This is a auto-generated unique API ID.
API Document NameName for the API document.
DescriptionDescription for the API document.


Here you can add miscellaneous information (such as ToS URL, contact name & email, license details, etc.), to append to the API Document.


NameDescription

Enable internal used API key?

Enables a simplified authentication method for APIs in the API document to be used within Joget, without requiring configuration from the Manage API Key userview menu.

This option allows a constant API key for convenient API calls within Joget context (example: writing AJAX API call in custom HTML), while still maintaining proper API key management via Manage API Key userview menu for API calls from an external environment. Hence, persisting the same internal API key upon import/export app across different Joget instances.

Here is a sample script that utilizes this feature:

<script> 
$(function(){ 
    $.ajax({ 
        url:'http://localhost:8080/jw/api/assignment/list', 
        dataType:'json', 
        async:true, 
        headers:{ 
            api_id : 'yourApiDocIdHere', 
            api_key : 'yourInternalApiKeyHere' 
        },
        type: 'GET', 
        success: function(req) { 
            console.log(req); 
        } 
    }); 
});
</script>
Internal API keyKey in any characters of your choice here to represent the API key for internal use only.
Internal API key permissionManage the permission on who can call the APIs internally. See Permission Control.




  • No labels