@wral/sdk-publisher
v0.1.0
Published
A Software Development Kit for working with Studio Publisher
Downloads
22
Keywords
Readme
Publisher SDK
The Publisher SDK
is a JavaScript SDK (Software Development Kit) designed to interact with a Publisher API. This SDK provides a method to make API calls to the Publisher API using REST URLs directly.
Installation
You can install the Publisher SDK
package via npm:
npm install publisher-sdk
Usage
To use the Publisher SDK
, you first need to import it into your JavaScript or TypeScript project:
import { createClient } from 'publisher-sdk';
Then, you can create a client instance with your configuration:
const config = {
apiKey: 'YOUR_API_KEY',
baseUrl: 'YOUR_BASE_URL', // Base URL of your Publisher API
};
const client = createClient(config);
After creating the client instance, you can use its method api()
to make API calls to the Publisher API. Here's an example:
// Make API call using api() method
const response = await client.api('/endpoint', { method: 'GET' });
API
createClient(config)
Creates a new client instance with the provided configuration.
config
: An object containing API configuration parameters:apiKey
: The API key for authentication.baseUrl
: The base URL of the Publisher API.
Returns a client instance with a method api()
for making API calls.
Methods
api(path, options)
: Makes an API call to the Publisher API using the provided path and options.path
: The path to the API endpoint.options
: The fetch options (e.g., method, headers, body).
sites()
: Lists all sites with publications.list(params)
: Lists publications at a parent path.params
: An object containingsite
,path
, and optionaldate
.
getPublication(params)
: Gets a publication as it was sent to the API at the exact path specified.params
: An object containingsite
,path
, and optionaldate
.
resolvePublication(params)
: Resolves a publication to an object with content, template, and metadata.params
: An object containingsite
,path
, and optionaldate
.
Methods return a promise that resolves with the response from the API.