https://github.com/yoast/subscription-api-javascript-client
The subscription API can be used by Yoast partners to create subscriptions in MyYoast.
https://github.com/yoast/subscription-api-javascript-client
Last synced: 10 months ago
JSON representation
The subscription API can be used by Yoast partners to create subscriptions in MyYoast.
- Host: GitHub
- URL: https://github.com/yoast/subscription-api-javascript-client
- Owner: Yoast
- Created: 2021-03-02T10:38:09.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2024-01-19T09:18:48.000Z (over 2 years ago)
- Last Synced: 2025-04-21T09:06:05.146Z (about 1 year ago)
- Language: JavaScript
- Size: 59.6 KB
- Stars: 0
- Watchers: 15
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Yoast provisioner API client
YoastProvisionerApiClient - JavaScript client for Yoast provisioner API client
The Yoast provisioning API
This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
- API version: 1.0.0
- Package version: 1.0.0
- Build package: io.swagger.codegen.v3.generators.javascript.JavaScriptClientCodegen
## Installation
### For [Node.js](https://nodejs.org/)
#### npm
To publish the library as a [npm](https://www.npmjs.com/),
please follow the procedure in ["Publishing npm packages"](https://docs.npmjs.com/getting-started/publishing-npm-packages).
Then install it via:
```shell
npm install Yoast provisioner API client --save
```
#### git
#
If the library is hosted at a git repository, e.g.
https://github.com/GIT_USER_ID/GIT_REPO_ID
then install it via:
```shell
npm install GIT_USER_ID/GIT_REPO_ID --save
```
### For browser
The library also works in the browser environment via npm and [browserify](http://browserify.org/). 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):
```shell
browserify main.js > bundle.js
```
Then include *bundle.js* in the HTML pages.
### Webpack Configuration
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:
```javascript
module: {
rules: [
{
parser: {
amd: false
}
}
]
}
```
## Getting Started
Please follow the [installation](#installation) instruction and execute the following JS code:
```javascript
var YoastProvisionerApiClient = require('Yoast provisioner API client');
```
Documentation on how to use the subscription API, can be found [in the developer docs.](https://developer.yoast.com/customization/myyoast/apis/subscription-api)