CloudObjects / Directory / Web API / WebAPIImportAPI
Sign in

WebAPIImportAPI

a phpmae:ControllerClass, WebAPI, phpmae:Class & HTTPEndpoint in Web API
Base URL

The endpoint is located at the following URL:
https://webapi.cloudobjects.io/import/

Authentication

This API can be used without authentication.

API Methods

These are the methods supported by the API:

  • POST /convertData Convert Data

    Converts an existing machine-readable API definition into a Web API object configuration. The existing API definition needs to be sent with the request.

    Required parameters:
    coid The COID for the Web API to be generated.
    data The content of the API definition.
    Optional parameters:
    audience The COID for the audience of the Web API.
    Success response:

    A JSON-LD representation of the Web API.

    Status Code 200
    Content Type application/ld+json

    swap_vertThis API does not support CORS, hence requests are proxied by CloudObjects. To prevent abuse of this feature, you need to sign in to make requests to this API.

  • GET /convertFromURL Convert from URL

    Converts an existing machine-readable API definition into a Web API object configuration. The existing API definition is taken from a URL.

    Required parameters:
    coid The COID for the Web API to be generated.
    url The URL to an API definition file.
    Optional parameters:
    audience The COID for the audience of the Web API.
    Success response:

    A JSON-LD representation of the Web API.

    Status Code 200
    Content Type application/ld+json

    swap_vertThis API does not support CORS, hence requests are proxied by CloudObjects. To prevent abuse of this feature, you need to sign in to make requests to this API.

Public PHP Methods
  • convertToWebAPI($coid, $audience, $data)

    No documentation available.

  • connect(Application $app)

    No documentation available.

Meta
URI / COID
coid://webapi.cloudobjects.io/WebAPIImportAPI content_copy
Revision
8-3996c281e9ab2fd33c8ecfeb0e740c8c content_copy
Last updated
2017-05-28 13:38 (UTC)
Usage permission
co:Vendor