@ciptex/plugin-sdk
v0.14.4
Published
@ciptex/plugin-sdk
Downloads
63
Maintainers
Keywords
Readme
Race Plugin SDK
The plugin-api helper library lets you write Node.js code to make HTTP requests to the Ciptex Race Plugin API.
Do not use Basic Authentication in a front-end application. Doing so can expose your Twilio credentials to end-users as part of the bundled HTML/JavaScript sent to their browser.
Installation
The easiest way to install plugin-sdk is from NPM. You can run the command below from your project directory to install the library:
npm install --save @ciptex/plugin-sdk@latest
Then in your code:
import { PluginClient } from "@ciptex/plugin-sdk"
Testing your installation
Try Listing Configuration like this:
import { PluginClient } from "@ciptex/plugin-sdk"
const accountSid = "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"; // Your Account SID from www.twilio.com/console
const authToken = "your_auth_token"; // Your Auth Token from www.twilio.com/console
const client = new PluginClient({ accountSid, authToken });
const main = async () => {
try {
// LIST EXAMPLE HERE
}
catch (error) {
console.error(error);
}
}
main()
It's okay to hardcode your credentials when testing locally, but you should use environment variables to keep them secret before committing any code or deploying to production. Check out How to Set Environment Variables for more information.
Using This Library
Authenticate Client
const accountSid = "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX";
const authToken = "your_auth_token";
const client = new PluginClient({ accountSid, authToken });
Create A New Record
import { PluginClient } from "@ciptex/plugin-sdk"
const accountSid = "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX";
const authToken = "your_auth_token";
const client = new PluginClient({ accountSid, authToken });
const main = async () => {
try {
//CREATE EXAMPLE HERE
}
catch (error) {
console.error(error);
}
}
main()
Get Existing Record
import { PluginClient } from "@ciptex/plugin-sdk"
const accountSid = "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX";
const authToken = "your_auth_token";
const client = new PluginClient({ accountSid, authToken });
const main = async () => {
try {
//GET EXAMPLE HERE
}
catch (error) {
console.error(error);
}
}
main()
Handling Exceptions
If the Plugin API returns a 400 or a 500 level HTTP response, the plugin-sdk library will throw an error which can be caught. 400-level errors are normal during API operation ("Invalid number", "Cannot deliver SMS to that number", for example) and should be handled appropriately.
More Documentation
Once you're up and running with the plugin-sdk library, you'll find code samples using the latest version in our REST API docs