API Glossary

Overview

Definitions for terms used in our API documentation.

API

Application program interface (API) is a set of routines, protocols, and tools for building software applications. An API specifies how software components should interact.

API Key

An authorization code passed in to an API request via a header or parameter to identify the requester.

Authentication

Identifying the user of the API. Common techniques for authentication include API Keys.

Callback

Callbacks are a feature that allows our system to automatically notify your server whenever certain events happen. When a callback is invoked, it sends a message containing information about the event in question to a specified URL.

Client

The client is the initiating party that sends an API request.

End point

The endpoint is the URL where our API service can be accessed by a client application. The same web service can have multiple endpoints, for example in order to make it available using different protocols.

Header

The header is what's sent preceeding the body of an HTTP request or response.

Method

The part of an API request that tells the server what the client wants to do.

Request

In the API, the client sends the server a request to do something.

Response

After the server receives a request from the client, it attempts to fulfill the request and send the client back a response.

REST

Representational state transfer (REST) is an architectural pattern for interacting with resources via HTTP methods.

Server

The server is software or hardware that provides a service by responding to requests across a network.

URI

The Unique Resource Identifier.

Web Service

Web Service is used to describe an API that is accessible over the internet through HTTP.

WDSL

WSDL is an XML format for describing network services as a set of endpoints operating on messages containing either document-oriented or procedure-oriented information.

XML-RPC

XML-RPC is a simple, portable way to make remote procedure calls over HTTP.

Translate »