Terminologies

Endpoints are specific URLs where an API can access resources or perform certain operations. They are the interaction points where the API receives requests and sends responses. Each endpoint is associated with specific HTTP methods (GET, POST, PUT, DELETE, etc.) that define the type of operations that can be performed.

Collections are a way to group multiple endpoints together. They organize endpoints into logical groups based on functionality, making it easier to manage and understand the API structure.

Microservices are a type of collection, which groups related Endpoints of a microservice.

Domains are distinct areas or realms of authority within a network. In the context of APIs, a domain typically represents the namespace under which the API operates (e.g., api.example.com).

Hosts refer to the servers or environments where the API or microservices are deployed. They are the physical or virtual machines that handle the API requests.

Protocols are the set of rules that define how data is transmitted and received over a network. Common protocols used in APIs include HTTP, HTTPS, WebSocket, and gRPC.

Environments refer to the different stages or setups in which the API operates, such as development, testing, staging, and production. Each environment may have different configurations and security measures.

Scans are automated processes that inspect the API and its endpoints for security vulnerabilities, compliance issues, and other risks. These can include static code analysis, dynamic analysis, and penetration testing.

User Flows are the paths or sequences of actions that users follow when interacting with the API. They represent typical usage patterns and can highlight critical touchpoints.

Compliance refers to adhering to industry standards, regulations, and best practices in API security. This can include GDPR, HIPAA, PCI-DSS, and other relevant frameworks.