{"id":17502,"date":"2023-01-31T19:47:00","date_gmt":"2023-01-31T10:47:00","guid":{"rendered":"https:\/\/docs.c-bot.pro\/?p=17502"},"modified":"2023-05-28T22:26:15","modified_gmt":"2023-05-28T13:26:15","slug":"for_developers","status":"publish","type":"post","link":"https:\/\/docs.c-bot.pro\/en\/user_guide\/for_developers\/","title":{"rendered":"For developers"},"content":{"rendered":"\n

<\/i> Home<\/a> > User guide<\/a> > For developers<\/p>\n\n\n\n

Introduction<\/h2>\n\n\n\n

Transition from \"For Developers\" in the global menu.<\/p>\n\n\n\n

With the developer functions, you can make settings for calling BOTs created in the cloud BOT as APIs, execution tests, and advanced settings related to cooperation with external services.<\/p>\n\n\n\n

<\/div>\n\n\n\n
\"\"<\/figure>\n\n\n\n

API<\/h2>\n\n\n\n

The created BOT can be published as an API.<\/p>\n\n\n\n

Basic settings<\/h3>\n\n\n\n
<\/div>\n\n\n\n
\"\"<\/figure>\n\n\n\n

Sets a public path (ID) and enable the API. The public ID you set will be used as part of the endpoint when calling the BOT.<\/p>\n\n\n\n

<\/div>\n\n\n\n
\"\"<\/figure>\n\n\n\n

When the API is published, \"Disable API\" is displayed to disable the API.<\/p>\n\n\n\n

API List<\/h3>\n\n\n\n

You need to enable the API in advance. In addition, public settings must be set for each BOT. The public ID you set will be used as part of the endpoint when calling the BOT.<\/p>\n\n\n\n

By switching tabs, currently published BOTs and unpublished BOTs are displayed alternatively.<\/p>\n\n\n\n

Publishing your BOT as API<\/h4>\n\n\n\n

BOT is set to \"Private\" by default.<\/p>\n\n\n\n

<\/div>\n\n\n\n
\"\"<\/figure>\n\n\n\n
    \n
  1. Select the [Private] tab.<\/li>\n\n\n\n
  2. Press the [Publish] button of the BOT whose API you want to publish.<\/li>\n\n\n\n
  3. Click the [Publish your API] button.<\/li>\n\n\n\n
  4. Click [OK] in the modal window.<\/li>\n<\/ol>\n\n\n\n

    About API<\/h4>\n\n\n\n

    You can view the information such as about BOT, Public settings, Endpoint.<\/p>\n\n\n\n

    <\/div>\n\n\n\n
    \"\"<\/figure>\n\n\n\n
    Enable\/Disable API<\/h5>\n\n\n\n

    You can enable\/disable it with the button in the \"Public Settings\". It is same as the button in the \"Basic settings\".<\/a><\/p>\n\n\n\n

    Testing API Using API Test Tool<\/h5>\n\n\n\n
    \n
    \n
    <\/div>\n\n\n\n

    You can actually run the BOT API using the test tool.<\/p>\n\n\n\n

    Scroll down the About API screen to test three types: BOT Execution (POST), Job Reference (GET), and Job Suspension (DELETE).<\/p>\n\n\n\n

    <\/div>\n\n\n\n

    Here, we explain the steps with using \"BOT Execution\" as an example.<\/p>\n\n\n\n

    The Request Body shows the parameter sample used when executing the BOT API. The sample is created with the initial values in the BOT.
    It is possible to rewrite the Request Body and test the execution.<\/p>\n\n\n\n

    <\/div>\n\n\n\n
      \n
    1. Select the access token to be used and enter the secret key.<\/li>\n\n\n\n
    2. Click [Send] to execute the API.<\/li>\n\n\n\n
    3. When the API execution is completed, the response contents will be displayed in \"Response Body\".<\/li>\n<\/ol>\n\n\n\n
      <\/div>\n<\/div>\n\n\n\n
      \n
      \"\"<\/figure>\n<\/div>\n<\/div>\n\n\n\n

      Event Hook<\/h2>\n\n\n\n

      A setting to notify the specified callback when a specific event occurs.<\/p>\n\n\n\n

      BOT Event<\/h3>\n\n\n\n

      A list of event hooks set in BOT will be displayed.<\/p>\n\n\n\n