Open API

What is OpenAPI?

OpenAPI Specification (formerly Swagger Specification) is an API description format for REST APIs. An OpenAPI file is machine-readable and describes entire RESTful web services, including available endpoints and methods/verbs on each endpoint (GET, PUT, POST, DELETE), input and output for each endpoint and more.

API specifications can be retrieved in YAML or JSON. The format is easy to learn and readable to both humans and machines. The complete OpenAPI Specification can be found on GitHub: OpenAPI 3.0.2 Specification

Read more about the Open API Initiative on www.openapis.org.

OpenAPI + RamBase API

The OpenAPI file retrieved from the RamBase API does not contain our entire API. Instead it contains the subset of API resources your API client has access to*. This client id is passed as a query parameter to get an OpenAPI file matching the APIs your client has access to. Example:

The OpenAPI file you retrieve from RamBase can be in several formats and versions:

• JSON, version 2: /openapi/v2/json?clientId={clientId}
• JSON, version 3: /openapi/v3/json?clientId={clientId}
• YAML, version 2: /openapi/v2/yaml?clientId={clientId}
• YAML, version 3: /openapi/v3/yaml?clientId={clientId}

* Note that currently there is a limit of 500 APIs.

Example file

It is possible to request an example file without first getting a client id. Just omit the client id query parameter in the request. Example:

The example file includes the following APIs:

• GET /sales/customers
• GET /sales/customers/{customerId}
• GET /sales/orders
• GET /sales/orders/{salesOrderId}
• GET /sales/orders/{salesOrderId}/items
• POST /sales/customers
• POST /sales/orders/{salesOrderId}/items
• POST /sales/orders/{salesOrderId}/items/{itemId}
• PUT /sales/customers/{customerId}
• DELETE /sales/customers/{customerId}