Book Resume 6- 7 Devasc Flashcards
Are often used for communication from a network controller to its management
software. For example, Cisco DNA Center has a software graphical user interface
(GUI) that is used to manage its own network controller.
Northbound APIs
If a network operator makes a change to a switch’s configuration in the management software
of the controller, those changes will then be pushed down to the individual devices
using a
Southbound APIs
Causes an application to wait for a response from the API in order to continue
processing data or function normally.
Synchronous APis
Provide a callback function so that the API response can be sent back at
another time, without the application having to wait for the entire transaction to complete.
Asynchronous APIs
Use HTTP methods
to gather and manipulate data. Because there is a defined structure for how HTTP works,
HTTP offers a consistent way to interact with APIs from multiple vendors.
Restful APIs
Is a predetermined string that
is passed from the client to the server. It is intended to be a pre-shared secret and should
not be well known or easy to guess because it functions just like a password.
API Key
An API key can be passed to the server in three
different ways:
String
■■ Request header
■■ Cookie
Allows a user to enter his or her username and password once and receive
a unique auto-generated and encrypted xxxxxx.
Custom Tokens
Is used to exchange data between applications that were
built on different programming languages, such as Java, .NET, and PHP
Simple Object Access Protocol
SOAP
SOAP messages, which typically consist of the following four main components,
are sent between the web applications and the clients
■■ Envelope
■■ Header
■■ Body
■■ Fault (optional)
Make it possible to execute code or a program on a remote
node in a network
Remote-Procedure Calls (RPCs)
Enumere the APIs Styles:
Rest, Sincronic, Asincronic, Remote Procedural Calls (RPC)
RESTful API Authentication
Basic Authentication, APIs Keys, Custom Tokens.
-Is one of the simplest and most common
authentication methods used in APIs.
Basic Authentication.
Is a set of functions and procedures intended
to be used as an interface for software components to communicate with each other.
An application programming interface (API)
Describe the APIs clasification:
- Service APIs
- Information APIs
- Hardware APIs
An application can call on another application to solve a
particular problem (see Figure 7-2). Usually these systems can exist independently. For
example, in a payment system, an application can call the API to accept payments via
credit cards.
Service APIs
Allows one application to ask another application
for information. Information in this context can refer to data gathered over time,
telemetry data, or a list of devices that are currently connected.
Information APIs
Gain access to the features
of hardware devices. Usually these APIs encompass some kind of hardware or
sensors, and an application can call this kind of API to get the GPS location or realtime
sensor data such as temperature or humidity.
Hardware APIs
API Access Types
There are typically three ways APIs can be accessed:
1/ Private
2/ Partner
3/ Public
In HTTP, in order to make a successful request to the server, the client needs to include four
items:
■■ URL (uniform resource locator)
■■ Method
■■ List of headers
■■ Body
A URL typically has four components,
■■ Protocol
■■ Server/host address
■■ Resource
■■ Parameters
Are user-defined HTTP callbacks. Are Triggered by an event, such as pushing code to a repository or typing a keyword in a chat window.
Webhooks
REST Constraints
** Client/server
■■ Stateless
■■ Cache
■■ Uniform interface
■■ Layered system
■■ Code on demand
Each individual request contains all the information the
server needs to perform the request and return a response, regardless of other requests made
by the same API user.
Stateless (REST)
In this strategy, the version number of the API is included in the
URL path.
URI path versioning
In this strategy, the version number is sent as a
query parameter in the URL.
Query parameter versioning
Are versioned by providing custom headers with the version
number included as an attribute.
Custom headers: REST APIs
This strategy allows you to version a single resource representation
instead of versioning an entire API
Content negotiation
What are the populars aproch to pagination?
■■ Offset-based pagination
■■ Keyset-based pagination, also known as continuation token or cursor pagination (recommended)
