Proxy API Settings in Garoon is a feature that can be optionally used when using JavaScript customization.
By using the proxy API settings, you can send requests to external services from the JavaScript that you use for customization.

We recommend that you use the Garoon proxy API settings after you have prepared the JavaScript file for customization.
JavaScript customization is available in Garoon general screens or in the following applications.

• Portal HTML portlet
• Scheduler
• Messages
• E-mail
• Workflow

Before you customize them, be sure to check the precautions.
For details on the precautions for customization, refer to Points to Check before Customization.

Add proxy API settings to Garoon.

1. Call garoon.base.proxy.send function in the JavaScript you customize.

   For customization examples using parameters, request specifications, and proxy API settings, refer to [Garoon JavaScript API] how to connect Garoon Scheduler to kintone on cybozu developer network.

2. Click the Administration menu icon (gear icon) in the header.

3. Click Garoon System Administration.

4. Select "Basic system administration" tab.

5. Click "API".

6. Click "Proxy API Settings".

7. On the "Proxy API Settings" screen, click Add.

   

8. On the "Add proxy configuration" screen, enter the "Proxy Code" field.

   You must set the proxy code.
   A proxy code used to call garoon.base.proxy.send function. The code should match the one specified with the function.
   You can specify the proxy code in up to 100 characters. If 101 or more characters are entered, the first 100 characters are registered.
   If the same proxy code already exists, an error occurs.
   

9. Set the "Method" field.

   A HTTP method used to call garoon.base.proxy.send function. The method should match the one specified with the function.
   The available methods are as follows:

   • GET
   • POST
   • PUT
   • PATCH
   • DELETE
   

10. Enter the "URL" field.

    The URL is mandatory.
    Enter the URL of the API to use. The URL must match the one specified in the function in forward matching.
    

11. Set the "Parameter" field.

    Adds the information of the parameter to the point specified in the function.
    When you use a GET request to send, the parameter set here can be added to it.

12. Set the "Header" field.

    Adds the information of the header to the point specified in the function.
    If the same header key exists in the function and the proxy API settings, the header key set in the proxy API settings overrides the one in function.
    If the same header key exists in the proxy API settings, the last key specified overrides the preceding one.

13. Set the "Body" field.

    This item is displayed when the "Method" field is POST, PUT, or PATCH.
    For conditions where body information is added, refer to the topic on Running External APIs in cybozu developer network.

14. Select "Enabled" for "Status" field.

    

15. Confirm your settings and click Add.

Change the proxy API settings.

1. Click the Administration menu icon (gear icon) in the header.

2. Click Garoon System Administration.

3. Select "Basic system administration" tab.

4. Click "API".

5. Click "Proxy API Settings".

6. On the "Proxy API Settings" screen, click the proxy code for the proxy API to change.

7. On the "Proxy configuration details" screen, click Edit.

   

8. On the "Edit proxy configuration" screen, change the settings as necessary.

9. Confirm your settings and click Save.

Delete proxy API settings.

Delete the proxy API settings one by one.

1. Click the Administration menu icon (gear icon) in the header.

2. Click Garoon System Administration.

3. Select "Basic system administration" tab.

4. Click "API".

5. Click "Proxy API Settings".

6. On the "Proxy API Settings" screen, select the proxy code for the proxy API to delete.

7. On the "Proxy configuration details" screen, click Delete.

   

8. Click Yes on the "Delete proxy configuration" screen.

Select multiple proxy API settings and delete them in bulk.

1. Click the Administration menu icon (gear icon) in the header.

2. Click "System settings".

3. Select "Basic system administration" tab.

4. Click "API".

5. Click "Proxy API Settings".

6. On "Proxy API Settings" screen, select checkboxes of proxy API to delete and click Delete.

   

7. Click Yes on the "Delete proxy configurations" screen.