API:Api-installation

From InClickAdServer

(Redirected from Api-installation)

Contents

Getting Started - API Activation / Installation

NOTICE: We are in the process of rewriting the API documentation.

Through the use of the inClick API, developers can interact with inClick Ad Server objects and processes from a remote server. Since the inClick API is a web service API, you are able to integrate the inClick Ad Server into just about any other service regardless of environment or operating system. Examples include:

  • Integration into an accounting system
  • Integration into a CRM (Customer Relationship Manager) system such as [Salesforce] or [SugarCRM]
  • Connecting the inClick Ad Server into your own user interface
  • Extending functionality of the core system (adding your own features)
  • Creating your own software application on the inClick Ad Server foundation.

The inClick Ad Server API will allow you to add, modify, delete and retrieve data. Nearly all functionality found in the existing user interface has a corresponding API service. Some functionality includes:

  • Advertiser
    • Account Information, Creation and Modification
    • Advertisement Creation and Modification. Includes:
      • Geographical Targeting
      • Keyword Targeting
      • Region Targeting
      • Channel Selection
      • Custom Filter Options (3)
    • Reporting and Statistics
    • Conversion Tracking Creation
    • Account Funding
  • Publisher
    • Account Information, Creation and Modification
    • Reporting and Statistics
  • System Administrator
    • Reporting and Statistics
    • Account Lists
    • Campaign Lists and Status
    • Publisher Account Processing - Clear, Post, and Pay
    • Advertiser Payment Processing
    • User Authentication
  • API Exclusive - Advanced Advertisement Request and Delivery Processor
    • Separated tracking for impressions from a given request. For example, request ten ads from the system, then tell the system which three were delivered.
    • Allows for external filtering and targeting options outside the platform.

Quick Start Checklist

The below is an abbreviated checklist on getting the inClick Ad Server API up and running. Each point below is outlined in depth within this document.

  1. Obtain the Developers API Key for your inClick Cloud Server deployment. This will be provided to you in a support ticket.
  2. Download the [API Client] package.
  3. Download [PHPOlait], a boiler-plate set of PHP code that provides a transparent bridge to your inClick Cloud Server deployment.
  4. Create your first API Call

System Requirements and Dependencies

The following list oulines requirements and dependencies that must be in place to use the inClick Ad Server API:

  • API Key(Required) - If you do not have an API Key for your inClick Cloud Server, please open a support ticket to have one generated for you.
  • The API PHP Client Package - The API Client Package contains the PHP objects to connect to your inClick Cloud Server.
  • PHPOlait - PHPOlait is a boiler-plate set of PHP code that provides a transparent bridge between PHP methods using a [JSON (JavaScript Object Notation)] RPC layer.
  • An inClick Ad Server deployment.

Installing the inClick Developers API

Coming Soon