| Access (bearer) token | In OAuth 2.0, a bearer token is a type of access token that is used by a client to access protected resources on behalf of the resource owner (user). The term "bearer" refers to the fact that the token itself is all that is needed to access the protected resource, similar to a bearer of a physical token or a ticket. Check out the API Authentication guide for more information about how to manage client credentials. |
| App | Represents a software application that interacts with Banqup APIs that is provided by the Banqup Dev Portal, and its registration on the portal facilitates authentication, access, and management of API usage for developers. |
| App ID | Represents a unique identifier assigned to an app that facilitates authentication, access control, analytics, and support within the Banqup developer portal's ecosystem.. |
| Authentication | Authentication is the process of verifying the identity of a user or system attempting to access an API. It ensures that the requester is who they claim to be. Banqup uses client credentials and OAuth 2.0 for authentication._ For more information on Banqup authentication, check out the API Authentication guide. |
| Authorization | Authorization is the process of determining whether a user or system has the necessary permissions to access specific resources or perform certain actions within the API. Once a user or system is authenticated, authorization determines what they can do. In Banqup, authorization is done via OAuth scopes. For more information on Banqup authorization, check out the API Authentication guide. |
| Authorization code | In OAuth 2.0, an authorization code is a temporary credential that is issued by the authorization server to the client application after the resource owner (user) has granted permission. The authorization code is used by the client application to obtain an access token, which can then be used to access protected resources on behalf of the resource owner. |
| Base URL | In a RESTful API, the base URL (Uniform Resource Locator) is the starting point or the root endpoint of the API. It forms the foundation for constructing URLs for accessing various resources and functionalities provided by the API. |
| Client credentials | In Banqup, the client credentials authorization grant is used, as defined by the OAuth 2.0 framework. It's used when the client application is acting on its own behalf rather than on behalf of a user. The two components of this authorization grant are: client ID (or API key) and client secret, used to generate a bearer token. Check out the API Authentication guide for more information about how to manage client credentials. |
| HTTP Codes | HTTP status codes are standardized numeric codes that indicate the outcome of an HTTP request. These codes are sent by a server in response to a client's request to communicate the result of the operation. Check out the Error Handling page for more information on how to handle errors on the Banqup Dev Portal. |
| OAuth 2.0 | OAuth 2.0 (Open Authorization 2.0) is an authorization framework that allows third-party applications to obtain limited access to an HTTP service, either on behalf of a resource owner or by allowing the third-party application to obtain access on its own behalf. It's widely used for delegated authorization and is commonly used in scenarios where a user wants to grant a third-party application access to their resources without sharing their credentials |
| OpenAPI | Represents a specification describing and documenting RESTful APIs. It defines a standard, language-agnostic interface for describing the structure and functionality of APIs, allowing developers to understand and interact with APIs more easily. |
| Payload | In the context of APIs, a payload contains the actual data being sent or received between client and server. |
| REST API | A REST API (Representational State Transfer Application Programming Interface) is a type of web service that allows different software applications to communicate with each other over the internet. It follows the principles of REST, which is an architectural style for designing networked applications. |