Skip to main content
Version: 3.2

Glossary

A glossary has been request for non-technical users to understand the technical terms used in the documentation. This glossary is not exhaustive and will be updated over time as new terms are introduced in the documentation.

General​

  • REST: Representational State Transfer, an architectural style for designing networked applications that relies on stateless communication and standard HTTP methods (GET, POST, PUT, DELETE).
  • API: Application Programming Interface, a set of rules and protocols for interacting with software applications. Usually using the XML or JSON format.
    • JSON: JavaScript Object Notation, a lightweight data-interchange format that is easy for humans to read and write and easy for machines to parse and generate.
    • XML: eXtensible Markup Language, a markup language that defines a set of rules for encoding documents in a format that is both human-readable and machine-readable.
  • HTTP: Hypertext Transfer Protocol: The protocol used for transmitting web pages over internet.
  • HTTPS: Hypertext Transfer Protocol Secure, an extension of HTTP that uses encryption (SSL/TLS) to secure data transmission between a client and a server.
  • SSL/TLS: Secure Sockets Layer/Transport Layer Security, cryptographic protocols designed to provide secure communication over a computer network, commonly used in HTTPS.
  • URL: Uniform Resource Locator, a reference (address) to a resource on the internet, typically consisting of a protocol, domain name, and path (e.g., https://www.example.com/api/v1/resource).
  • TCP/IP: Transmission Control Protocol/Internet Protocol, a suite of communication protocols used to interconnect network devices on the internet.
  • MQTT: Message Queuing Telemetry Transport, a lightweight messaging protocol designed for low-bandwidth, high-latency, or unreliable networks, often used in IoT applications.
  • Endpoint: A specific URL where an API can be accessed by a client application to perform a specific function.
  • Request: A message sent by a client to an API endpoint to perform an action or retrieve data.
  • Response: A message sent by an API back to the client in reply to a request, containing the result of the request or an error message.
  • Payload: The data sent in a request or response, often in JSON format, that contains the information needed to perform an action or return
  • Status code: A numerical code returned in an API response that indicates the result of the request (e.g., 200 for success, 400 for bad request, 500 for server error).
  • Authentication: The process of verifying the identity of a user or system, often through credentials such as usernames and passwords, tokens, or API keys.
  • Authorization: The process of determining whether a user or system has permission to access a resource or perform an action, often based on roles or permissions.
  • Webhook: A method of augmenting or altering the behavior of a web application with custom callbacks, often used to notify external systems of events.
  • UUID: Universally Unique Identifier, a 128-bit number used to uniquely identify information in computer systems. Example: 123e4567-e89b-12d3-a456-426614174000.

Infrastructure​

  • Dedicated Server: A physical or virtual server that is exclusively used by a single client or organization, providing enhanced performance and security.
  • VPS: Virtual Private Server, a virtualized server that mimics a dedicated server within a shared hosting environment, offering more control and resources than standard shared hosting.
  • Virtual Machine: An emulation of a computer system that provides the functionality of a physical computer, allowing multiple operating systems to run on a single physical machine.
  • LXC: Linux Containers, a lightweight virtualization technology that allows multiple isolated Linux systems (containers) to run on a single host.
  • Docker: A platform that uses OS-level virtualization to deliver software in packages called containers, which
  • SSH-Key: A secure access credential used in the SSH protocol to authenticate users and provide secure access to remote servers without the need for passwords.
  • Token: A string of characters used for authentication and authorization in API requests, often generated by a server and provided to a client after successful authentication.

Paypuce Specific​

  • Paypuce Identifier (PID): A unique identifier used in the Paypercloud system to identify both the source (remote POS) and target (POS terminal) of a transaction, consisting of 12 hexadecimal characters.
  • Remote POS: The external device (cash register) that initiates requests to the Payper
  • POS: The payment terminal that receives requests from the remote POS and processes transactions, acting as the target in the Paypercloud system.
  • POS Group: A configuration entity in the Paypercloud back-office that links remote POS devices
  • Franchise: A business model where a company (franchisor) allows individuals or other companies (franchisees).
  • Customer: The main account in the Paypercloud system, representing a business or organization that uses the platform.
  • Store: A location or business unit within a Customer account in the Paypercloud system,
  • Event: equivalent or a Store, for the PayPerPot Product (different from the store as it has a start/end date)
  • remoteAction: An action initiated by a remote POS that can result in a transaction or trigger other processes within the Paypercloud system.
  • Pop: Point of Payment, the role of the POS terminal in the Paypercloud system as the target that processes transactions initiated by the remote POS.