API Glossary
A comprehensive glossary of terms used throughout the APIVerve documentation and in API development generally.
A
API (Application Programming Interface)
A set of rules and protocols that allows different software applications to communicate with each other. APIVerve provides RESTful APIs that you can call over HTTP to access various services.
API Key
A unique identifier used to authenticate requests to the APIVerve API. Your API key should be kept secret and included in the X-API-Key header of every request.
Async/Asynchronous
A programming pattern where operations don't block execution while waiting for a response. Many API clients use async patterns to make non-blocking HTTP requests.
Authentication
The process of verifying the identity of a user or application. APIVerve uses API key authentication to ensure only authorized users can access the APIs.
Authorization
The process of determining what actions an authenticated user is allowed to perform. In APIVerve, your plan level determines which features and rate limits apply.
B
Base URL
The root URL for all API requests. For APIVerve, the base URL is https://api.apiverve.com/v1/. All endpoint paths are appended to this URL.
Billing Cycle
The recurring period for subscription charges and token resets. For paid plans, this is typically monthly from your subscription start date.
Body
The main content of an HTTP request or response. For POST requests, the body contains the data being sent to the API, typically in JSON format.
C
Cache
Temporary storage of API responses to reduce redundant requests and improve performance. Caching strategies vary by endpoint and data freshness requirements.
Callback
A function passed as an argument to another function, executed after an operation completes. Common in asynchronous API integrations.
Client
The application or code that makes requests to an API. In APIVerve's context, your application acts as the client making requests to our servers.
Content-Type
An HTTP header that specifies the media type of the request or response body. APIVerve uses application/json for most requests and responses.
CORS (Cross-Origin Resource Sharing)
A security mechanism that allows or restricts web pages from making requests to a different domain. APIVerve supports CORS but recommends server-side API calls.
cURL
A command-line tool for making HTTP requests. Commonly used for testing APIs and included in our code examples.
D
Dashboard
The web interface at dashboard.apiverve.com where you manage your API keys, view usage analytics, and configure your account settings.
Data Validation
The process of ensuring data meets certain criteria before processing. Many APIVerve APIs validate input data and return informative errors for invalid inputs.
Deprecation
The process of phasing out an API feature or endpoint. Deprecated features remain functional but may be removed in future versions.
E
Endpoint
A specific URL path that represents a particular API function. For example, /weather is the endpoint for the Weather API. Each endpoint accepts specific parameters and returns structured data.
Environment Variable
A variable set outside your code, often used to store sensitive data like API keys. Best practice is to store your APIVerve key in an environment variable.
Error Code
A numeric HTTP status code indicating the result of an API request. Common codes include 200 (success), 400 (bad request), 401 (unauthorized), 429 (rate limited), and 500 (server error).
Error Handling
The practice of anticipating and managing errors in API responses. Good error handling improves application reliability and user experience.
F
Fetch
A modern JavaScript API for making HTTP requests. Often used as an alternative to XMLHttpRequest for calling APIs from web browsers or Node.js.
G
GET Request
An HTTP method used to retrieve data from an API. GET requests pass parameters in the URL query string and should not modify server data.
GraphQL
A query language for APIs that allows you to request exactly the data you need. APIVerve's GraphQL interface (in ALPHA) lets you query multiple APIs in a single request.
H
Header
Metadata sent with an HTTP request or response. APIVerve requires the X-API-Key header for authentication and returns rate limit information in response headers.
HTTP (Hypertext Transfer Protocol)
The protocol used for communication between clients and servers on the web. All APIVerve API requests use HTTP/HTTPS.
HTTP Method
The action to perform on a resource. APIVerve APIs use GET for retrieving data and POST for sending data. The required method is documented for each endpoint.
HTTPS
HTTP Secure - the encrypted version of HTTP using TLS. All APIVerve API requests must use HTTPS for security.
I
Idempotent
A property where making the same request multiple times produces the same result. GET requests are idempotent; making the same GET request twice returns the same data.
Integration
The process of connecting your application with an API. APIVerve provides SDKs and documentation to simplify integration.
J
JSON (JavaScript Object Notation)
A lightweight data format used for API responses. All APIVerve APIs return data in JSON format by default, making it easy to parse in any programming language.
JSON Schema
A specification for describing the structure of JSON data. API documentation often uses JSON Schema to define expected request and response formats.
L
Latency
The time delay between sending a request and receiving a response. APIVerve optimizes for low latency to ensure fast API responses.
Library
Pre-written code that simplifies API integration. APIVerve provides official libraries (SDKs) for popular programming languages.
M
Middleware
Software that acts as a bridge between an application and an API. Often used for logging, authentication, or request/response transformation.
Mock Server
A simulated API server for testing. APIVerve's VerveKit includes a mock server feature for development and testing without consuming tokens.
O
OAuth
An authorization framework that allows third-party applications to access user data. APIVerve uses simpler API key authentication rather than OAuth.
OpenAPI
A specification for describing REST APIs. APIVerve provides OpenAPI schemas for all APIs, enabling automatic client generation and documentation.
P
Pagination
The practice of dividing large result sets into smaller pages. APIs returning many items often support pagination via limit and offset parameters.
Parameter
A value passed to an API to customize its behavior. Parameters can be required or optional and are sent as query strings (GET) or in the request body (POST).
Payload
The data sent in the body of a POST request. For APIs that accept complex input, the payload is typically sent as JSON.
POST Request
An HTTP method used to send data to an API. POST requests include data in the request body and are used for creating resources or submitting complex data.
Postman
A popular API testing tool. APIVerve provides an official Postman collection with pre-configured requests for all APIs.
Promise
A JavaScript object representing the eventual completion of an asynchronous operation. Modern API clients often return Promises for handling responses.
Q
Query String
Parameters appended to a URL after a question mark (?). For GET requests, API parameters are typically sent as query strings, e.g., ?city=NewYork&units=metric.
Quota
A limit on resource usage over a period. In APIVerve, your monthly token quota determines how many API calls you can make.
R
Rate Limit
The maximum number of API requests allowed in a time period. APIVerve enforces rate limits to ensure fair usage. Limits vary by plan and are communicated via response headers.
Request
An HTTP call made to an API endpoint. A request includes the URL, method, headers, and optionally a body or query parameters.
Response
The data returned by an API after processing a request. APIVerve responses include a status field, error information (if any), and the data payload.
REST (Representational State Transfer)
An architectural style for designing networked applications. APIVerve follows REST principles, using standard HTTP methods and returning stateless responses.
Retry Logic
Code that automatically retries failed requests after a delay. Important for handling temporary failures like rate limits or network issues.
S
Schema
A formal description of data structure. API schemas define the expected format of requests and responses, enabling validation and documentation.
SDK (Software Development Kit)
A collection of tools and libraries for integrating with an API. APIVerve provides official SDKs for Node.js, Python, PHP, and Go.
Server
A computer or program that processes API requests and returns responses. APIVerve's servers handle millions of API requests daily.
Status Code
See Error Code. HTTP status codes indicate whether a request succeeded (2xx), had client errors (4xx), or server errors (5xx).
Synchronous
An operation that blocks execution until complete. Synchronous API calls wait for the response before continuing code execution.
T
Throttling
The practice of limiting request rates to prevent overload. When rate limited, APIVerve returns a 429 status code with retry information.
Timeout
The maximum time to wait for an API response before canceling the request. Setting appropriate timeouts prevents your application from hanging.
Token
A unit of API usage measurement in APIVerve. Each API call consumes one or more tokens based on the API's complexity. Your plan includes a monthly token allowance.
TLS (Transport Layer Security)
A cryptographic protocol that provides secure communication. All APIVerve API traffic is encrypted using TLS 1.2 or higher.
U
URI (Uniform Resource Identifier)
A string that identifies a resource. URLs are a type of URI that includes the protocol and location of a resource.
URL (Uniform Resource Locator)
The web address used to access an API endpoint. A complete API URL includes the base URL, endpoint path, and any query parameters.
URL Encoding
The process of converting special characters in URLs to a safe format. Parameters with spaces or special characters must be URL-encoded.
V
Validation
The process of checking that data meets requirements. APIs validate input parameters and return errors for invalid data.
Versioning
The practice of maintaining multiple API versions for backward compatibility. APIVerve includes version numbers in the base URL (e.g., /v1/).
VerveKit
APIVerve's collection of developer tools including the GraphQL explorer, embedded forms builder, JSON Bin storage, and Mock Server for testing.
W
Webhook
A callback URL that receives data when an event occurs. While most APIVerve APIs are request-based, some integrations support webhook notifications.
Wrapper
Code that simplifies API interactions by abstracting HTTP details. SDKs are wrappers that make API calls easier in specific programming languages.
X
X-API-Key
The HTTP header used to send your API key with APIVerve requests. Include this header with your API key value in every request.
XML (Extensible Markup Language)
A markup language for encoding data. While APIVerve primarily uses JSON, some APIs support XML output format.
Was this page helpful?
Help us improve our documentation