PureCloud API CH1 API Overview

Question 1

API

Answer 1

An API (Application Programming Interface) is a set of functions that allows applications to access data and interact with external software components, operating systems, or microservices.

Question 2

API Explorer

Answer 2

The API Explorer is a simple web interface to perform most of the API operations. Consider the API Explorer as a web app to make requests to API endpoints.

Question 3

Code Editor

Answer 3

Code Editor

The Code Editor allows you to run code samples against the Genesys Cloud JavaScript SDK.

Question 4

Search Query Builders

Answer 4

The Search Query Builder provides a user interface that speeds up the creation of search queries. You pick the search criteria.

Question 5

Archy

Answer 5

Archy

Archy is a Genesys Cloud Architect YAML ( “YAML Ain’t Markup Language” ) processor that lets you create Architect flows from YAML files you write.

Question 6

REST (REpresentational State Transfer)

Answer 6

Software architectural style used by the client to request services/data and the server to process the request and deliver a response to the client.

Question 7

What is considered a REST

Answer 7

1) Client-server separation: the client determines how responses are displayed to the user, allowing the server to parse the request and produce the response.
2) Stateless requests: the server does not have to store any context between requests—everything needed is within each request.
3) Resource identifiers: the interface is designed around resources that are identified by URLs.

Question 8

What is considered a restful api?

Answer 8

A Web service that follows these REST API style guidelines is called RESTful. Such a Web service must provide its Web resources in a textual representation and allow them to be read and modified with a stateless protocol, such as HTTP, and a predefined set of operations.

Question 9

What is Platform APIs?

Answer 9

The Genesys Cloud API endpoints that contain data or functions to configure the interface

Question 10

In a REST API, the primary data representation?

Answer 10

Resource

Question 11

collection resource

Answer 11

https://api.example.com/user-management/users indicates that a resource identified by its location in the api.example.com domain can be accessed using the HTTP protocol

Question 12

singleton resource

Answer 12

https://api.example.com/user-management/users/userID is referred to as a singleton resource because it is used to identify a specific user.

Question 13

HTTP Methods

Answer 13

HTTP is the most common protocol used by REST API web service requests and responses. CRUD.

Question 14

Data Formats

Answer 14

REST API process flow must be able to understand each other and they do that by providing metadata that indicates the format of the data being presented by the request and the response.

Question 15

Common format for REST API?

Answer 15

JSON (JavaScript Object Notation) and XML (eXtensible Markup Language)

Question 16

REST API Requests component dependent on HTTP method.

Answer 16

1) Request Type (HTTP Method)
2) API endpoint URL (Resource)
3) Authorization (access token) is the security token, as discussed in the Authorization lesson of this chapter.
4) Content-Type (Data Format) this is generally in the format of Content (media) and the Type (e.g. JSON). Content-Type for JSON is application/json. The HTTP headers | Content-Type web page provides more details Content-Type.

Body: Key-Value in the body based on the endpoint schema.