4. Uploading Starter Templates

You can upload the Open Integration starter templates from SCM to a registered customer Git repository. This step creates the initial template files, including config_template.json, profile_template.json, and other starter artifacts in the customer Git repository. You can upload the started templates to the Git repository using the /openintegration/git_template_upload API:

  • Method: POST
  • Endpoint: /openintegration/git_template_upload
  • Description: Pushes the starter templates from the SCM static_templates directory to the specified customer Git branch and directory. SCM creates a commit only when one or more files are added or changed.
  • Sample API call request for default upload:
    {
        "git": {
            "git_id": "<git_id>"
        }
    }

    By default, SCM uploads the templates to the main branch and the openint-templates directory.

  • Sample API call request for a custom branch or directory upload:
    {
        "git": {
            "git_id": "<git_id>",
            "git_template_branch": "<git_template_branch>",
            "git_template_directory": "< git_template_directory >"
        }
    }

In the above sample payload:

  • <git_id> is the identifier of the customer Git repository previously registered with SCM.
  • <git_template_branch> is the Git branch to which SCM uploads the starter templates. If omitted, SCM uses the main branch. It is an optional parameter.
  • <git_template_directory> is the target directory in the customer Git repository. If omitted, SCM uses the openint-templates directory.