1. Service Cloud Chat REST APIREST API for Chat in B2C Service
  2. Reference
  3. Terminology

Terminology

If you're new to Oracle 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 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.

  • Bearer Authentication: An HTTP authentication scheme that involves security tokens called bearer tokens. The name 'Bearer authentication' can be understood as 'give access to the bearer of this token'. The bearer token in this case is the JSON Web Token (JWT) returned in the response of the agentTokens or the establishSessions call.

  • Endpoint: A URI on a server that can return a response.

  • 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 Client.

  • Request Payload: Data that is sent in the body of the HTTP request. It is normally applicable to POST and PATCH requests.

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

  • Uniform Resource Identifier (URI): Part or all of a path used to address a particular endpoint 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 endpoint, requestEngagement, is the URN: https://chat_rest_server_domain.com/engagement/api/consumer/{fqSiteName}/v1/requestEngagement.