---
title: "Glossary"
slug: "glossary"
updated: 2025-10-24T20:54:02Z
published: 2025-10-24T22:08:17Z
canonical: "guide.youraspire.com/glossary"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://guide.youraspire.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Glossary

#### API

Application Programming Interface.  

#### Attribute

Data element associated with endpoint.  

#### Bearer Authentication

Token-based authentication method used to secure endpoints.  

#### Body Parameters

Data that is sent in the body of the HTTP request to create or alter data.  

#### Client

An application or device that processes a response from a server after sending a request to API.  

#### Client ID

A unique identifier assigned to a client application in authentication and authorization systems, often used in protocols like OAuth.  

#### Data type

Format of the data transmitted between the client and server. Click [Data Types](https://swagger.io/docs/specification/data-models/data-types/) to view the data types used in the Swagger UI and the API Guide.  

#### Entity

A resource or object.  

#### Escape Special Charectars

A practice used to prevent misinterpretation given a specific context by assigning a set of characters to represent a special character.  

#### Field

Attribute within an object on a database table.  

#### Headers

Metadata in the form of key-value pairs that provide information about a request or response. It will typically consist of the request or response URL and authorization information.  

#### HTTPS

Hypertext Transfer Protocol Secure transmits encrypted data over the internet using SSL/TLS.  

#### Idempotent

Ensures that the method does not alter the state of the resource on the server.  

#### Integration

Process of exchanging information between two systems that are independent of each other via an API.  

#### JWT

 Acronym for JSON Web Token- authorizes secure data transmission between the client and host server when a client provides this in the authorization header of a request. Token format: JWT self-containing (header, payload, signature). Click [https://jwt.io/introduction](https://jwt.io/introduction) for more information.  

#### JSON

An acronym for Javascript Object Notation. It is a markup language used to store and exchange information between computers. Go to JSON Data Interchange Format for more information.  

#### Key

 Encrypted key used for securing and authorizing communication between systems.  

#### Method

HTTP verb used to indicate an action that should be performed on a resource.  

#### Nest property/object

 A field embedded within another property. For example, if you have an "address" property within a "User object," Address is the nested property.  

#### Nested object or property

An object enclosed within another object or property.  

#### Nested property

A property enclosed within another object or property.   

#### Object

 Resource or entity.  

#### Payload

Specified data sent from a request or received from a response. It does not include additional information, such as a header or metadata.   

#### Property

Regulates how data stored in a field can be seen or changed.   

#### Query Parameter

 A key/value pair appended to a URL in web requests used in APIs to customize responses, filter data, or specify parameters for server operations.  

#### Request

An action to interact with a resource initiated by the client system.  

#### Response

Data sent from a server to a client system given the request provided by the client system.  

#### RESTful API

 Representational State Transfer - also known as REST API - a web service API that adheres to the REST API architectural design principles. However, it is not a protocol, so while there are commonly followed design principles, there is a place for flexibility; thus, unlike SOAP, which only uses the XML data format, RESTful APIs can use multiple formats to exchange data.  

#### Schema

Format, data type, and constraints of a data type value.  

#### Server

Software that hosts resources.  

#### Status Code

Numeric code within an HTTP response that represents the outcome of a client request to a server. Indicates whether or not the request encountered an error or was successfully sent to the server.  

#### Swagger

OpenAPI Specification (OAS), is an open-source framework that can design, document, and consume RESTful APIs. Swagger generates interactive and user-friendly documentation for APIs based on the information provided in the OpenAPI Specification. This documentation includes details about endpoints, request and response formats, authentication methods, and more.  

#### URI

 Uniform resource identifiers. A unique address allows a resource to be identified on a network.  

#### URL

 A type of URI used to fetch or access a resource in a network.