A library for integrating with PayPalHttp.
The @paypal/paypalhttp node module is an essential tool for developers looking to integrate PayPal functionalities into their applications seamlessly. This library simplifies the process of making HTTP requests to PayPal's APIs, handling everything from the execution of requests to the processing of responses. By using @paypal/paypalhttp, developers can ensure that their applications communicate with PayPal's services in a robust and efficient manner. The module supports various HTTP methods, providing flexibility depending on the needs of the application, whether it's processing payments, managing accounts, or retrieving transaction data.
To get started with this powerful library, developers can easily install it using the command `npm install @paypal/paypalhttp`. This installation process integrates the PayPal HTTP client into your project, setting up the groundwork for implementing PayPal's API calls. The simplicity of this command belies the complexity it abstracts away, making it straightforward for developers to add sophisticated payment processing capabilities to their applications without deep diving into the intricacies of HTTP protocol and API communication.
The benefits of using @paypal/paypalhttp are numerous. It not only ensures high standards of security when dealing with sensitive payment information but also enhances the scalability of applications. As businesses grow and transaction volumes increase, the library's efficient handling of requests ensures that applications remain fast and responsive. Furthermore, @paypal/paypaypalhttp is designed to handle potential errors gracefully, providing clear error messages and robust debugging capabilities, which are crucial for maintaining a smooth user experience and quick troubleshooting.
Core dependencies of this npm package and its dev dependencies.
undefinedbusboy, chai, eslint, eslint-config-braintree, mocha, nock, sinon
A README file for the @paypal/paypalhttp code repository. View Code
PayPalHttp is a generic HTTP Client.
In it's simplest form, an HttpClient exposes an #execute method which takes an HttpRequest, executes it against the domain described in an Environment, and returns a Promise.
An Environment describes a domain that hosts a REST API, against which an HttpClient will make requests. Environment is a simple class that contains one property, baseUrl.
let env = new Environment('https://example.com');
HTTP requests contain all the information needed to make an HTTP request against the REST API. Specifically, one request describes a path, a verb, any path/query/form parameters, headers, attached files for upload, and body data. In Javascript, an HttpRequest is simply an object literal with path, verb, and optionally, requestBody, and headers populated.
HTTP responses contain information returned by a server in response to a request as described above. They are simple objects which contain a statusCode, headers, and a result, which represents any data returned by the server.
let req = {
path: "/path/to/resource",
verb: "GET",
headers: {
"X-Custom-Header": "custom value"
}
}
client.execute(req)
.then((resp) => {
let statusCode = resp.statusCode;
let headers = resp.headers;
let responseData = resp.result;
});
Injectors are closures that can be used for executing arbitrary pre-flight logic, such as modifying a request or logging data. Injectors are attached to an HttpClient using the #addInjector method. They must take one argument (a request), and may return nothing, or a Promise.
The HttpClient executes its injectors in a first-in, first-out order, before each request.
let client = new HttpClient(env);
client.addInjector((req) => {
console.log(req);
});
client.addInjector((req) => {
req.headers['Request-Id'] = 'abcd';
});
...
The Promise returned by HttpClient#execute maybe be rejected if something went wrong during the course of execution. If the server returned a non-200 response, this error will be an object that contains a status code, headers, and any data that was returned for debugging.
client.execute(req)
.then((resp) => {
let statusCode = resp.statusCode;
let headers = resp.headers;
let responseData = resp.result;
})
.catch((err) => {
if (err.statusCode) {
let statusCode = err.statusCode;
let headers = err.headers;
let message = err.message;
} else {
// Something else went wrong
console.err(err);
}
});
(De)Serialization of request and response data is done by instances of Encoder. PayPalHttp currently supports json encoding out of the box.
PayPalHttp-Node is open source and available under the MIT license. See the LICENSE file for more info.
Pull requests and issues are welcome. Please see CONTRIBUTING.md for more details.