ElepayApi - JavaScript client for elepay_api_ elepay APIはRESTをベースに構成された決済APIです。支払い処理、返金処理など、決済に関わる運用における様々なことができます。 This SDK is automatically generated by the OpenAPI Generator project:
- API version: 1.0
- Package version: 1.0
- Build package: org.openapitools.codegen.languages.JavascriptClientCodegen
For Node.js
To publish the library as a npm, please follow the procedure in "Publishing npm packages".
Then install it via:
npm install elepay_api_ --save
Finally, you need to build the module:
npm run build
To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json
(and this README). Let's call this JAVASCRIPT_CLIENT_DIR
. Then run:
npm install
Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR
:
npm link
To use the link you just defined in your project, switch to the directory you want to use your elepay_api_ from, and run:
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
Finally, you need to build the module:
npm run build
If the library is hosted at a git repository, e.g.https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:
npm install GIT_USER_ID/GIT_REPO_ID --save
The library also works in the browser environment via npm and browserify. After following
the above steps with Node.js and installing browserify with npm install -g browserify
,
perform the following (assuming main.js is your entry file):
browserify main.js > bundle.js
Then include bundle.js in the HTML pages.
Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:
module: {
rules: [
{
parser: {
amd: false
}
}
]
}
Please follow the installation instruction and execute the following JS code:
var ElepayApi = require('elepay_api_');
var defaultClient = ElepayApi.ApiClient.instance;
// Configure HTTP basic authorization: BasicAuth
var BasicAuth = defaultClient.authentications['BasicAuth'];
BasicAuth.username = 'YOUR USERNAME'
BasicAuth.password = 'YOUR PASSWORD'
var api = new ElepayApi.ChargeApi()
var charge = new ElepayApi.ChargeReq(); // {ChargeReq} 支払リクエスト
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.createCharge(charge, callback);
All URIs are relative to https://api.elepay.io
Class | Method | HTTP request | Description |
---|---|---|---|
ElepayApi.ChargeApi | createCharge | POST /charges | Create charge |
ElepayApi.ChargeApi | listCharges | GET /charges | List charges |
ElepayApi.ChargeApi | retrieveCharge | GET /charges/{id} | Retrieve charge |
ElepayApi.ChargeApi | revokeCharge | DELETE /charges/{id} | revoke charge |
ElepayApi.RefundApi | createRefund | POST /charges/{id}/refunds | Create refund |
ElepayApi.RefundApi | listChargesRefunds | GET /charges/{id}/refunds | List refunds |
ElepayApi.RefundApi | listRefunds | GET /refunds | List refunds |
ElepayApi.RefundApi | retrieveChargeRefund | GET /charges/{id}/refunds/{refundId} | Retrieve refund |
ElepayApi.RefundApi | retrieveRefund | GET /refunds/{refundId} | Retrieve refund |
- ElepayApi.BadRequestError
- ElepayApi.ChargeDateTimeType
- ElepayApi.ChargeDto
- ElepayApi.ChargeReq
- ElepayApi.ChargesResponse
- ElepayApi.ElepayError
- ElepayApi.ElepayRestError
- ElepayApi.InternalServerError
- ElepayApi.PaymentMethodType
- ElepayApi.RefundDto
- ElepayApi.RefundExtDto
- ElepayApi.RefundReq
- ElepayApi.RefundsResponse
- Type: HTTP basic authentication