External API integration guide

You can integrate your system-managed data into Kuroco using APIs. API integration enables efficient operation without data management duplication.

This document describes the recommended specifications for external API integration.

Method of integration

You can prevent various problems by clearly defining the specifications when developing your project with external API integration. OpenAPI and GraphQL are the most common API standardization methods.

These mechanisms can automatically prevent omissions and recognition discrepancies. You can also use specification description tools to facilitate communications.

OpenAPI users

For OpenAPI users, please follow one of the methods below.

Create a definition file

The first method is to create a JSON or YAML file.

Make your playground/IDE publicly available in the external API

Use Swagger Editor to make your playground/IDE available to other users.

For security reasons, we recommend using basic authentication with this method.

Create an HTML file

This method uses the OpenAPI specification tool and generates an HTML file with a documentation generator.

GraphQL users

For GraphQL users, please follow one of the methods below.

Create a definition file

You can create files using the schema definition language (schema.graphqls).

Make your playground/IDE publicly available in the external API

Use GraphiQL to make your playground/IDE available to other users.

For security reasons, we recommend using basic authentication with this method.

Create an HTML file

This method uses the GraphQL specification tool and generates an HTML file with a documentation generator.

Specification tools

Below are some examples of API specification tools:

More information

For more information about OpenAPI and GraphQL, please refer to the official websites below:

If you have any other questions, please use our contact form or Slack workspace.