zoko

v2.0.1

Published

2 years ago

ZOKO REST APIs provide programmable access to reach your customers and conduct business on your approved social channels

Downloads

0High
0Medium
0Low

greenaro

zoko_api

ZokoApi - JavaScript client for zoko_api

Overview ZOKO REST APIs provide programmable access to reach your customers and conduct business on your approved social channels. The API identifies and authenticates you via an API Key provided. Responses are available as JSON. > Message resources should suffice if you are using the API just for outgoing communication. Otherwise, please do check out the Webhook resources as well to achieve seemless 2-way communication. If you are looking for ZOKO API v1.0, you can find it here # API Host `json https://chat.api.zoko.io/v2`

This SDK is automatically generated by the OpenAPI Generator project:

API version: 2.0.1
Package version: 2.0.1
Build package: org.openapitools.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install zoko_api --save

Finally, you need to build the module:

npm run build

Local development

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 zoko_api from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

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:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

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.

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:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var ZokoApi = require('zoko_api');

var defaultClient = ZokoApi.ApiClient.instance;
// Configure API key authorization: API_Key_Authentication
var API_Key_Authentication = defaultClient.authentications['API_Key_Authentication'];
API_Key_Authentication.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//API_Key_Authentication.apiKeyPrefix['apikey'] = "Token"

var api = new ZokoApi.AccountApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.accountTemplatesGet(callback);

Documentation for API Endpoints

All URIs are relative to https://message.zoko.io/v2

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- ZokoApi.AccountApi | accountTemplatesGet | GET /account/templates | Get Message Templates ZokoApi.CustomerApi | customerIdGet | GET /customer/{id} | Get Customer ZokoApi.CustomerApi | customerIdMessagesDelete | DELETE /customer/{id}/messages | Delete Messages ZokoApi.MessageApi | messageIdAttachmentAttachmentIdGet | GET /message/{id}/attachment/{attachmentId} | Get Message Attachment ZokoApi.MessageApi | messageIdDelete | DELETE /message/{id} | Delete message ZokoApi.MessageApi | messageIdGet | GET /message/{id} | Get Message ZokoApi.MessageApi | messageIdHistoryGet | GET /message/{id}/history | Get Message History ZokoApi.MessageApi | messagePost | POST /message | Send Message ZokoApi.WebhookApi | webhookGet | GET /webhook | List Webhooks ZokoApi.WebhookApi | webhookIdDelete | DELETE /webhook/{id} | Delete Webhook ZokoApi.WebhookApi | webhookIdGet | GET /webhook/{id} | Get Webhook ZokoApi.WebhookApi | webhookIdPut | PUT /webhook/{id} | Update Webhook ZokoApi.WebhookApi | webhookPost | POST /webhook | Create Webhook ZokoApi.WhatsAppGroupApi | channelsWhatsappGroupGet | GET /channels/whatsapp/group | List Groups ZokoApi.WhatsAppGroupApi | channelsWhatsappGroupIdGet | GET /channels/whatsapp/group/{id} | Get Group ZokoApi.WhatsAppGroupApi | channelsWhatsappGroupIdInviteUrlDelete | DELETE /channels/whatsapp/group/{id}/inviteUrl | Delete Group Invite URL ZokoApi.WhatsAppGroupApi | channelsWhatsappGroupIdInviteUrlGet | GET /channels/whatsapp/group/{id}/inviteUrl | Get Group Invite URL ZokoApi.WhatsAppGroupApi | channelsWhatsappGroupIdMembersDelete | DELETE /channels/whatsapp/group/{id}/members | Delete Group Members ZokoApi.WhatsAppGroupApi | channelsWhatsappGroupIdMembersGet | GET /channels/whatsapp/group/{id}/members | Get Group Members ZokoApi.WhatsAppGroupApi | channelsWhatsappGroupPost | POST /channels/whatsapp/group | Create Group

Documentation for Models

Documentation for Authorization

API_Key_Authentication

Type: API key
API key parameter name: apikey
Location: HTTP header