1. OKCS REST APIREST API for Knowledge Advanced in B2C Service
  2. Reference
  3. Terminology

Terminology

If you're new to Oracle B2C Service Knowledge Advanced REST API, you're bound to run into unfamiliar terms. Review these definitions to better understand the tech lingo.

  • Base64: Encoding schemes that convert binary data to a text string format, so that the data can be securely transmitted in HTTP headers. Base64 encodes by dividing a string of bytes into groups of bits, so that each group maps to one of 64 characters, avoiding the risk of sending raw binary data across networks.

  • Basic Authentication: A simple and commonly used identifying process built into the HTTP protocol that collects credentials as user name / password pairs. The REST client sends HTTP requests with the Authorization header in the Base64-encoded format: Basic username:password. It's usually implemented with a secondary level of security.

  • Collection Resource: Represents a list of items, such as categories, languages, locales, or users.

  • Endpoint: A URI on a server that can return a response. The terms resource and endpoint can be used interchangeably.

  • HTTP Header: Components of request and response messages in Hypertext Transfer Protocol (HTTP) that carry information and define the operating parameters of an HTTP transaction. For examples, see Work with your REST API Client.

  • OAuth 2.0: An open-standard authorization framework that allows users to access an HTTP Service. The framework allows either to get the user access using a third-party application or directly on behalf of a user using an approval interaction mechanism. For more information, see The OAuth 2.0 Authorization Framework.

  • Resource: An object with a type, associated data, and relationships to other resources. Examples include a single document, image, object, or a collection of resources. You can use a set of HTTP methods to access a resource. To learn more, see Resource Types .

  • Resource Index URI: The starting point for all authenticated access to REST resources, providing the path to the set of available top-level Uniform Resource Identifier (URI) entry points. In this example path, the resource index URI is https://site.example.com/km/api/latest/content

  • Response Payload: Data that the server returns when answering an HTTP request. The response payload might be a JSON, XML, or text document.

  • Root Resource: An individual resource that does not require a containing context. It is generally the top level collection without path parameters and is found in a resource index.

  • Singular Resource: Represents a single entity, such as a language, a category, or a locale. To learn more, see Resource Types .

  • Uniform Resource Identifier (URI): Part or all of a path used to address a particular resource involved in an interaction. Examples of URIs include URLs (Uniform Resource Locater) and URNs (Uniform Resource Name). In the following URI example, the full address string is the URL, and the target resource, content, is the URN: https://site.example.com/km/api/latest/content