provisioning_api

ProvisioningApi - JavaScript client for provisioning_api The Provisioning API allows to retrieve information about the Acquisio accounts of an organization and manage its assets. An Acquisio account regroups one or many publisher accounts (like AdWords, Bing Ads or Facebook). # Versioning The Provisioning API is versioned with a single number for major versions. The major version will be incremented when incompatible API changes are done. The major version is included in the url of the endpoints. Minor versions with backward compatible changes are documented in the Provisioning API v1 Release Notes. # Security The Provisioning API is secured with OAuth 2.0. OAuth 2.0 Grant Type | Swagger OAuth Flow | Token URL ---------------------|--------------------|----------- Client Credentials | application | https://api.clientcampaigns.com/token Resource Owner Password Credentials | password | https://api.clientcampaigns.com/token This SDK is automatically generated by the Swagger Codegen project:

• API version: v1
• Package version: v1
• Build date: 2017-06-28T10:21:21.676-04:00
• Build package: class io.swagger.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 provisioning_api --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:

    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.

Getting Started

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

var ProvisioningApi = require('provisioning_api');
 
var defaultClient = ProvisioningApi.ApiClient.default;
 
// Configure OAuth2 access token for authorization: oauth2ClientCredentials
var oauth2ClientCredentials = defaultClient.authentications['oauth2ClientCredentials'];
oauth2ClientCredentials.accessToken = "YOUR ACCESS TOKEN"
 
// Configure OAuth2 access token for authorization: oauth2ResourceOwnerPasswordCredentials
var oauth2ResourceOwnerPasswordCredentials = defaultClient.authentications['oauth2ResourceOwnerPasswordCredentials'];
oauth2ResourceOwnerPasswordCredentials.accessToken = "YOUR ACCESS TOKEN"
 
var api = new ProvisioningApi.AccountsApi()
 
var accountId = 789; // {Integer} ID of the account.
 
var body = new ProvisioningApi.CloneContract(); // {CloneContract} Account object with all of its fields.
 
 
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.accountsIdAccountIdCloneCampaignPost(accountId, body, callback);
 

Documentation for API Endpoints

All URIs are relative to https://api.clientcampaigns.com/provisioning/v1

Class	Method	HTTP request	Description
ProvisioningApi.AccountsApi	accountsIdAccountIdCloneCampaignPost	POST /accounts/id/{accountId}/clone-campaign	Clone or clone-sync campaigns with the Power Cloner
ProvisioningApi.AccountsApi	accountsIdAccountIdGet	GET /accounts/id/{accountId}	Retrieves a single account
ProvisioningApi.AccountsApi	accountsIdAccountIdPatch	PATCH /accounts/id/{accountId}	Partly updates a single account
ProvisioningApi.AccountsApi	accountsIdAccountIdPut	PUT /accounts/id/{accountId}	Updates all fields of a single account
ProvisioningApi.AccountsApi	accountsPost	POST /accounts	Creates a new account
ProvisioningApi.CampaignsApi	campaignsImportPost	POST /campaigns/import	Import campaigns from a publisher
ProvisioningApi.PublishersApi	publishersDelete	DELETE /publishers	Deletes multiple publisher accounts.
ProvisioningApi.PublishersApi	publishersIdPublisherIdCampaignsGet	GET /publishers/id/{publisherId}/campaigns	Retrieves a list of campaigns at the publisher
ProvisioningApi.PublishersApi	publishersIdPublisherIdDelete	DELETE /publishers/id/{publisherId}	Deletes a single publisher account
ProvisioningApi.PublishersApi	publishersIdPublisherIdUnlinkPost	POST /publishers/id/{publisherId}/unlink	Unlinks a single publisher account.
ProvisioningApi.PublishersApi	publishersPost	POST /publishers	Add a publisher account from a master account
ProvisioningApi.PublishersApi	publishersUnlinkPost	POST /publishers/unlink	Unlinks multiple publisher accounts.

Documentation for Models

• ProvisioningApi.Account
• ProvisioningApi.AccountResponse
• ProvisioningApi.AddPublisherAccountItem
• ProvisioningApi.CloneContract
• ProvisioningApi.CloneContractResponse
• ProvisioningApi.Error
• ProvisioningApi.PublisherCampaign
• ProvisioningApi.PublisherCampaignsResponse

Documentation for Authorization

oauth2ClientCredentials

• Type: OAuth
• Flow: application
• Authorization URL:
• Scopes: N/A

oauth2ResourceOwnerPasswordCredentials

• Type: OAuth
• Flow: password
• Authorization URL:
• Scopes: N/A