KR20120136666A

KR20120136666A - A contents service interface providing system based on open apis and the method thereof

Info

Publication number: KR20120136666A
Application number: KR1020110055729A
Authority: KR
Inventors: 송광헌
Original assignee: 주식회사 피씨엔
Priority date: 2011-06-09
Filing date: 2011-06-09
Publication date: 2012-12-20
Also published as: WO2012169775A9; WO2012169775A3; WO2012169775A2; KR101296321B1

Abstract

PURPOSE: An opened API(application program interface) based content service interface providing system and method thereof are provided to enable a manager of a content server to offer a content sharing service to other web site server. CONSTITUTION: An API registration unit(31) creates a service description in a registered service API by registering a content service in standardized and opened API. A processing module execution unit(32) executes a processing module of the opened API. An execution request of the service API is received from a user of a website server, an API processing unit(33) executes the service API by using the opened API processing module. An access management unit(34) controls the access of a user by authenticating the user. [Reference numerals] (31) API registration unit; (32) Processing module execution unit; (33) API processing unit; (34) Access management unit; (41) API item DB; (42) API statistic DB; (43) Authentication information DB

Description

A contents service interface providing system based on open APIs and the method

The present invention relates to an open API-based content service interface providing system and method for registering, providing, and executing a content service provided by a content server as an application programming interface (API).

In general, Open API (Application Programming Interface) refers to a connection protocol that enables other systems to call and utilize a specific function when developing an application program. In other words, the Open API exposes the API to the outside world so that an unspecified number of users can easily and easily develop and use the application program.

In this case, the protocol between the parties, that is, the connection protocol should be standardized so that the unspecified majority can use it. Web Services is a representative Open API method that is internationally standardized.

Through the open API as described above, a sharing service that can be shared by providing a web service on the Internet for each service unit is possible. In other words, the shared service refers to a business module that can be externally called using a standard method (standard interface) so that a user and a provider may have different information system environments.

Shared services allow you to design web services with Service Oriented Architecture. Service-oriented architecture is a new technology and business paradigm that 'services', 'connects' and 'utilizes' distributed resources (information, business functions, systems, etc.).

Service-oriented architectures provide a highly interoperable structure that utilizes standards, making them easy to connect and use, and highly responsive, even when the operating environment of resources is heterogeneous. In addition, in order to realize the knowledge and information society, it is necessary to build a shared service and infrastructure based on a service-oriented architecture.

In other words, through a service-oriented architecture, service providers can develop and provide information systems that are independent of the user's environment (including future users). In addition, service users can use services provided by various organizations or departments to construct or modify business processes without separate integration work or conversion by providers. In particular, various terminals and networks may be utilized in various applications or businesses at a minimum cost through "shared serviceization".

In particular, as the type and amount of resources (content) having high socio-economic value are increasing in public institutions and private companies, the demand for resource sharing and utilization is increasing.

However, since there is no development tool that can manage this easily and effectively, a separate application must be developed when creating a shared service. In other words, in order to produce a shared service in a conventional system, an application developer needed a separate development method by selecting a service method such as SOAP (Simple Object Access Protocol) or REST (Representational State Transfer). . For this reason, inefficiency exists in the process of becoming a shared service.

Therefore, in order to overcome this, the production and management of the shared service is more convenient, and the technology that can produce and manage the shared service without additional costs is desperately needed.

An object of the present invention is to solve the problems described above, to provide a system and method for providing an open API-based content service interface for providing and executing the content service provided by the content server as an API (Application Programming Interface) It is.

In order to achieve the above object, the present invention relates to an open API-based content service interface providing system for registering, providing, and executing a content service provided by a content server as an application programming interface (API). An API registration unit for registering with an API and creating a service specification for a registered content service (hereinafter, referred to as a service API); A processing module execution unit executing the processing module of the open API; And an API processing unit for executing the service API by the open API processing module when receiving a request for executing the service API from the user of the website server.

The present invention also provides a system for providing an open API-based content service interface, wherein the system, when receiving a request for executing the service API from a user of a website server, authenticates the user requesting to execute the service API and the user It characterized in that it further comprises an access management unit for performing the access control by.

In addition, the present invention is a system for providing an open API-based content service interface, wherein the access management unit any of key-based authentication using the user key (AccessKey) and user secret key (AccessSecretKey) and IP address authentication using the IP address (Address) It is characterized by using one or more.

In another aspect, the present invention, in the open API-based content service interface providing system, the access management unit collects and stores statistical information about the execution of the service API.

In another aspect, the present invention provides a system for providing an open API-based content service interface, wherein the API processing unit converts a result of executing the service API into a web data format by a web protocol and transmits the result to the website server.

In addition, the present invention provides a system for providing an open API-based content service interface, wherein the web protocol is HTTP (hypertext transfer protocol) 1.0 or higher, and the web data format is XML (eXtensible Markup Languag) or JSON (JavaScript Object Notation). It is characterized by that.

In addition, the present invention is an open API-based content service interface providing system, wherein the open API is any one or more of REST (Representational State Transfer), SOAP (Simple object access, Protocol), RSS / ATOM, RDF (Resource Description Framework) It is characterized by.

The present invention also relates to a method for providing an open API-based content service interface that registers, provides, and executes a content service provided by a content server as an application programming interface (API). Registering with; (b) creating a service description for a registered content service (hereafter referred to as a service API); (c) providing, by the website server, a content service using the service API according to the service specification; (d) requesting a content service of the service API by accessing the website server from a user terminal; (e) receiving a service API execution request from a user terminal at a website server, and executing the service API by the open API processing module.

The invention also relates to a computer readable recording medium having recorded thereon a program for performing the method.

As described above, according to the system and method for providing an open API-based content service interface according to the present invention, the administrator of the content server can provide a service for sharing content in another website server without developing a separate application. Is obtained.

In particular, according to the system and method for providing an open API-based content service interface according to the present invention, a service representative can easily produce, modify, delete, and share services in a manner such as SOAP, REST, RSS, ATOM, and RDF using a GUI tool. By distributing, it is possible to reduce the development period without incurring additional costs.

1 is a diagram showing a configuration of an overall system for carrying out the present invention.
2 and 3 is a block diagram and system configuration diagram of the configuration of the open API-based content service interface providing system according to an embodiment of the present invention.
4 shows an example of a REST service registration screen according to the present invention.
5 shows an example of a SOAP service registration screen according to the present invention.
6 illustrates an example of an RSS / ATOM service registration screen according to the present invention.
7 shows an example of an execution result screen of the open API service according to the present invention.
8 illustrates an example of an access control screen of an open API service according to the present invention.
9 is a flowchart illustrating a method for providing an open API based content service interface according to an embodiment of the present invention.
Description of the Related Art [0002]
11: administrator terminal 12: user terminal
20: network
30: interface server (system) 31: API register
32: processing module execution unit 33: API processing unit
34: access management unit 40: database
50: content server 60: website server

DETAILED DESCRIPTION OF THE PREFERRED EMBODIMENTS Hereinafter, the present invention will be described in detail with reference to the drawings.

In addition, in describing this invention, the same code | symbol is attached | subjected and the repeated description is abbreviate | omitted.

First, examples of the configuration of the entire system for carrying out the present invention will be described with reference to Fig.

As shown in FIG. 1, an example of the entire system for implementing the present invention includes an administrator terminal 11, a user terminal 12, a content server 50, an interface server 30, and a website server 60. It consists of. In addition, a network 20 for connecting the user terminal 12 and the servers 30 and 50 is also included.

The manager terminal 11 is a conventional computing terminal such as a PC, a notebook, a netbook, a tablet PC, a PDA, a mobile, and the like used by a manager of a content server. The manager, through the manager terminal 11, accesses the interface server 30 and processes tasks such as registering a content service of the content server 50. In addition, input data for processing is input through the input device of the manager terminal 11, the processing result is output through an output device such as a screen of the manager terminal (11). In the following description, the operation performed by the administrator means that the operation is performed through the manager terminal 11. It is to be noted that reference numeral 11 is also attached to the manager in addition to the terminal.

The user terminal 12 is a conventional computing terminal such as a PC, a laptop, a netbook, a tablet PC, a PDA, a mobile, etc. used by a user who wants to use a content service provided by the content server 50. The user accesses the interface server 30 or the website server 60 through the user terminal 12 and processes a content service request job. In addition, input data for processing is input through an input device of the user terminal 12, and the processing result is output through an output device such as a screen of the user terminal 12. Hereinafter, a description of a user performing a task means a task performed by the user terminal 12. In addition, reference numeral 12 is also applied to the user in addition to the terminal.

The content server 50 is a conventional server and is connected to the network 20 to provide a content service. For example, the content server 50 is a server operated by a content provider (CP) that stores content in a database and provides the stored content in the form of an open API service. In other words, the content server 50 is responsible for representational state transfer (REST), simple object access, protocol (SOAP), RSS / ATOM, and resource description (RDF) of resources, operations, and content tables. Provided with open API such as Framework).

For example, the content server 50 is a server of an operator who operates an online shopping mall. The content server 50 stores product information (product name, product type, price, discount information, etc.) of a product posted in the online shopping mall as a content in a database. And it can provide its own product information to the website server 60, such as price comparison companies.

The website server 60 is a conventional web service server and is connected to the network 20 to provide a web service to the user terminal 12. That is, the website server 60 may be constructed to serve as a kind of web server or web service server. For example, the website server 60 shows the processed result on the web page or receives necessary input data through the web page. That is, the website server 60 communicates with the user terminal 12 to provide its own service. In this case, the web page is meant to include driving software for performing a specific task such as a web application, in addition to simple text, images, multimedia, and the like.

At this time, the website server 60 provides a content service of the content server 50 using an open API. That is, using the open API of the content service, a service providing the content of the content server 50 is implemented in its own site.

For example, the website server 60 may implement a content service for price comparison using an open API of the content server 50 that provides product information of an online shopping mall. At this time, the website server 60 accesses the contents of the content server 50 using open APIs such as REST, SOAP, RSS / ATOM, RDF, and the like. And the content is provided directly or processed.

The interface server 30 is a normal server, and registers an API of a content service by an administrator's request of the content server 50, and receives the service API request from the website server 60 implemented by the registered API. Allow server 50 to process the request.

In other words, the interface server 30 is connected to the network with the manager terminal 11, and provides a registration service to register the API for the content service. A content service registered as an open API is called a "service API". The interface server 30 prepares and distributes a service API as a service specification.

Each website server 60 implements a content service on the web using a service API according to the service specification. The content service implemented on the web will be referred to as a "content web service". The content web service of the website server 60 is provided to the user terminal 11.

When the user terminal 11 requests a content web service, the content web service drives a service API, and the interface server 30 executes the service API to perform the request.

At this time, the interface server 30 transmits the result obtained by executing the service API to the website server 60 or the user terminal 12. The result of the service API is provided in a standardized web data format such as XML (eXtensible Markup Languag) or JSON (JavaScript Object Notation). In addition, the protocol for transmitting the service API results also uses a web standard protocol, for example, HTTP (hypertext transfer protocol) 1.0 or higher.

The database 40 includes an API specification DB 41 for storing information about a registered service API, an API statistics DB 42 for storing statistical information about use of the service API, and an authentication information DB for user authentication ( 43). However, the configuration of the database 40 is only a preferred embodiment, and in the development of a specific device, it may be configured in a different structure by a database construction theory in view of the ease and efficiency of access and search.

Next, a configuration of the open API-based content service interface providing system 30 (hereinafter, referred to as an interface system) according to an embodiment of the present invention will be described with reference to FIGS. 2 and 3. 2 is a block diagram illustrating a configuration of an interface system according to an embodiment of the present invention, and FIG. 3 is a diagram illustrating a system configuration of an interface system.

As shown in FIG. 2 or FIG. 3, the interface system 30 includes an API registration unit 31, a processing module execution unit 32, and an API processing unit 33. In addition, the access management unit 34 may be configured to further include.

The API registration unit 31 registers the content service as a standardized open API, and creates a service specification for the registered content service (hereinafter referred to as service API).

That is, the content service of the content server 50 is registered with the open API. At this time, the open API uses at least one of REST (Representational State Transfer), SOAP (Simple object access, Protocol), RSS / ATOM, RDF (Resource Description Framework).

Meanwhile, the function of the API register 31 may be implemented as a server function of the interface system 30 or may be implemented on a client. That is, the first embodiment is implemented on the server of the interface system 30. Therefore, to register a service API, a registration page is provided on a web page, and a registration process is performed by input of the web page.

In addition, in the second embodiment, it may be implemented as a program (or application) installed in the manager terminal 11 of the client end. It provides an interface for registering the service API, receives input for registration, and transmits the result to the server when the input of the registration contents of the service API is completed.

The API registration unit 31 provides a registration screen for each standard according to the standard of each open API.

First, a process of registering a REST service will be described with reference to FIG. 4.

4A is a screen for registering a content service of a content server to a REST service. At this time, enter the ID name, address, and access control information of the service.

The screen of FIG. 4B automatically registers basic operations of the REST service.

The screen of Fig. 4C generates GET / PUT / POST / DELETE, which is a basic method of HTTP in REST. That is, the basic methods used for REST services are GET, POST, DELETE, and PUT. That is, in the case of REST, a resource is represented by a URL and a REST service is defined by defining a method for the resource. The address of the service means the location of the resource.

By selecting the table to be serviced by the screen interface of FIG. 4D, an entity is automatically generated.

As described above, when the API registration unit 31 registers the service API for the content service, as shown in FIG. 4E, the list of registered service APIs may be viewed.

In addition, as shown in FIG. 4F, the API registration unit 31 creates a specification for the registered service API. In this case, the REST service specification is preferably provided in a Web Application Description Language (WADL).

Next, a process of registering a SOAP service will be described with reference to FIG. 5.

As shown in FIG. 5A, when the API registration unit 31 registers a service API for a content service, the API registration unit 31 may view a list of registered SOAP service APIs.

5B is a screen for registering an operation of a SOAP service. In this case, parameters, SQL query statements, etc. are defined for the operation.

The screen of Fig. 5C generates an entity of the SOAP service. When a table in the content DB of the content server is selected, all the fields of the table are displayed, thereby creating the entity by defining the entity. 4D is a screen showing details of a registered service API.

In addition, as in the case of the REST above, the API registration unit 31 creates a specification for the registered service API. In this case, it is preferable that the SOAP service specification is provided in WADL (Web Application Description Language).

Next, a process of registering an RSS / ATOM service will be described with reference to FIG. 6.

As shown in FIG. 6A, when the API registration unit 31 registers a service API for a content service, the API registration unit 31 may view a list of registered RSS / ATOM service APIs.

6B and 6C are screens for registering an RSS / ATOM service.

In addition, as in the case of REST and SOAP, the API register 31 creates a specification for the registered service API. In this case, it is preferable that the SOAP service specification is provided in a WSDL (Web Service Description Language).

The processing module execution unit 32 executes the processing module of the open API.

In other words, it executes execution modules that can handle open APIs such as REST, SOAP, RSS / ATOM, and RDF services. In this case, as shown in FIG. 3, each service execution module is executed for each service.

The REST service 32a of FIG. 3 processes a response to a user's request as a REST service (or service API) by a service specification generated by the processing module execution unit 32 and distributed by the API registration unit 31. .

3 is a SOAP service (or service API) based on a service specification generated by the processing module execution unit 32 and distributed by the API registration unit 31, and processes a response to a user's request. .

The SRSS / ATOM service 32c of FIG. 3 is an RSS / ATOM service (or service API) based on the service specification generated by the processing module execution unit 32 and distributed by the API registration unit 31 to the user's request. Process the response.

The RDF service 32c of FIG. 3 processes the response to the user's request as an RDF service (or service API) based on the service specification generated by the processing module execution unit 32 and distributed by the API registration unit 31. .

That is, the processing module execution unit 32 distributes (DEPLOY), starts (START), STOPs (TOP) the processing module of the open API, for example, REST, SOAP, RSS / ATOM, RDF services.

The API processing unit 33 executes the service API by the open API processing module when receiving a request for executing the service API from the user of the website server.

In addition, the API processing unit 33 converts the result of executing the service API into a web data format by a web protocol and transmits the result to the website server 60.

At this time, the web protocol for communicating the execution result is a protocol over HTTP (hypertext transfer protocol) (HTTP) 1.0, and the web data format of the execution result is expressed in XML (eXtensible Markup Languag) or JSON (JavaScript Object Notation). By providing the web standard as described above, the execution result can be displayed on the web browser in the web form in the website server 60 or the user terminal 12.

Fig. 7 shows an example of the execution result by each service.

7A shows the execution result by the REST service, and FIGS. 7B and 7C show the execution result by the SOAP service and the RSS / ATOM service, respectively.

When the access manager 34 receives a request for executing the service API from the user of the website server, the access manager 34 authenticates the user requesting to execute the service API and performs access control by the user.

In particular, the access manager 34 uses at least one of key-based authentication using an access key and an access secret key and IP address authentication using an IP address. That is, either key-based authentication or one of the IP addresses, or a combination of both.

In addition, the access manager 34 collects and stores statistical information about the execution of the service API. For example, REST / SOAP services provide a limit on user access. Service traffic can be controlled by providing unlimited access per user and limit of daily access.

The access manager 34 provides a screen for defining and reading the access control as shown in FIG. 8. FIG. 8A is a user management screen for managing information such as user ID, status, access key, FIG. 8B is a screen for managing user access control, and FIG. 8C is a screen for managing user access statistics.

Next, an open API based content service interface providing method according to an embodiment of the present invention will be described with reference to FIG. 7.

As shown in Figure 7, the open API-based content service interface providing method includes the steps of (a) registering the content service as a standardized open API (S10); (b) creating a service specification for a registered content service (hereinafter, referred to as a service API) (S20); (c) providing, by the website server, a content service using the service API according to the service specification (S30); (d) accessing the website server from the user terminal and requesting a content service of the service API (S40); (e) If the website server receives a request for the execution of the service API from the user terminal, it may further comprise the step (S50) for executing the service API by the open API processing module.

In the description of the open API-based content service interface providing method, the description of the open API-based content service interface providing system described above will be referred to.

As mentioned above, although the invention made by this inventor was demonstrated concretely according to the said Example, this invention is not limited to the said Example, Of course, a various change is possible in the range which does not deviate from the summary.

The present invention is applicable to the development of an open API-based content service interface providing system that registers, provides, and executes a content service provided by a content server as an application programming interface (API).

Claims

In the open API-based content service interface providing system that registers, provides and executes a content service provided by a content server as an application programming interface (API),
An API registration unit for registering the content service with a standardized open API and creating a service specification for a registered content service (hereinafter, referred to as a service API);
A processing module execution unit executing the processing module of the open API; And
And an API processor configured to execute the service API by the open API processing module when receiving a request for executing the service API from the user of the website server.

The system of claim 1, wherein the system is
Upon receiving a request for executing the service API from a user of a website server, the open API base further comprises an access management unit for authenticating the user requesting to execute the service API and performing access control by the user. Content service interface provision system.

The method of claim 2,
The access management unit is an open API-based content service interface providing system, characterized in that using any one or more of the key based authentication using the user key (AccessKey) and the user secret key (AccessSecretKey) and the IP address authentication using the IP address (Address). .

The method of claim 2,
And the access management unit collects and stores statistical information about execution of the service API.

The method of claim 1,
And the API processing unit converts the result of executing the service API into a web data format by a web protocol and transmits the result to the website server.

The method of claim 5,
The web protocol is a hypertext transfer protocol (HTTP) 1.0 or higher protocol, and the web data format is eXtensible Markup Languag (XML) or Java Script Object Notation (JSON).

7. The method according to any one of claims 1 to 6,
The open API is an open API-based content service interface providing system, characterized in that at least one of REST (Representational State Transfer), SOAP (Simple object access, Protocol), RSS / ATOM, RDF (Resource Description Framework).

In the method of providing an open API-based content service interface that registers, provides, and executes a content service provided by a content server as an application programming interface (API),
(a) registering the content service with a standardized open API;
(b) creating a service description for a registered content service (hereafter referred to as a service API);
(c) providing, by the website server, a content service using the service API according to the service specification;
(d) requesting a content service of the service API by accessing the website server from a user terminal;
(e) when the website server receives a request for executing a service API from a user terminal, executing the service API by the open API processing module.

A computer-readable recording medium recording a program for performing the method of providing an open API-based content service interface of claim 8.