linkemperor-api 1.0.0

data/lib/linkemperor-api/vendors.rb

@@ -0,0 +1,193 @@
+
+require 'net/http'
+require 'uri'
+require 'json'
+
+class LinkemperorVendor
+  class LinkemperorApiException < RuntimeError
+  end
+
+  def initialize(api_key, base_path = nil)
+    @base_path = base_path || 'http://app.linkemperor.com'
+    @api_key = api_key
+  end
+
+  def exec_get(uri)
+    uri = URI(uri)
+    result = Net::HTTP.get_response(uri)
+    if result.is_a?(Net::HTTPSuccess)
+      JSON.parse(result.body)
+    else
+      raise LinkemperorApiException.new result.body
+    end
+  end
+
+  def exec_post(parameters, method, uri)
+    uri = URI(uri)
+    req = case method
+            when 'put'
+              Net::HTTP::Put.new(uri.request_uri)
+            when 'post'
+              Net::HTTP::Post.new(uri.request_uri)
+            when 'delete'
+              Net::HTTP::Delete.new(uri.request_uri)
+            end
+    req.body = JSON.dump(parameters)
+    req.content_type = "application/json"
+    result = Net::HTTP.start(uri.hostname, uri.port) do |http|
+      http.request(req)
+    end
+    #result = Net::HTTP.post_form(uri, converted_params)
+    if result.is_a?(Net::HTTPSuccess)
+      if result.body == 'false'
+        false
+      elsif result.body == 'true'
+        true
+      else
+        if method != 'delete'
+          JSON.parse(result.body)
+        else
+          result.body
+        end
+      end
+    else
+      raise LinkemperorApiException.new result.body
+    end
+  end
+
+  
+  # We call orders placed for your link building Service a Blast.
+  # Use this method to retrieve all outstanding orders for your link building service(s).
+  # 
+  # We will respond with the 500 first outstanding blasts for either the provided Service ID, or if none is provided, for all of your Services.
+  # Parameters:
+  # - service_id: ID of a Service.  If provided, the response will be scoped to just that service ID.
+  def get_blasts(service_id = nil)
+    
+    
+    
+  
+    exec_get("#{@base_path}/api/v2/vendors/blasts.json?api_key=#{@api_key}")
+  
+  end
+  
+  # Pulls the next blast from the order queue, marks it as having been started,
+  # and returns full information about the Blast, including Targets and Output URLs, if available.
+  # Parameters:
+  # - service_id: ID of a Service.  If provided, the response will be scoped to just that service ID.
+  def get_next_blast(service_id = nil)
+    
+    
+    
+  
+    exec_get("#{@base_path}/api/v2/vendors/blasts/next.json?api_key=#{@api_key}")
+  
+  end
+  
+  # Pulls a batch of blast from the order queue, marks them as having been started,
+  # and returns full information about the Blast, including Targets and Output URLs, if available.
+  # Parameters:
+  # - service_id: ID of a Service.  If provided, the response will be scoped to just that service ID.
+  # - batch_size: Batch size.  If not provided, the default batch size is 100
+  def get_next_batch_blasts(service_id = nil, batch_size = nil)
+    
+    
+    
+  
+    exec_get("#{@base_path}/api/v2/vendors/blasts/next_batch.json?api_key=#{@api_key}")
+  
+  end
+  
+  # Once you've completed link building for a request, you need to submit the URLs where links were built.  This PUT method does that.
+  # 
+  # After we receive this submission, we will verify the links provided within 24 hours.
+  # Once the links prove to be valid, we will credit your account immediately. If we cannot
+  # find enough valid backlinks in the links that you provided, we will suspend payment pending a manual review.
+  # Parameters:
+  # - id: ID # of the Blast
+  # - links: A string containing the list of links to submit (newline delimited)
+  def submit_built_link(id, links)
+    
+    
+    
+    if id.nil?
+      raise LinkemperorApiException.new('id should not be empty')
+    end
+    
+    if links.nil?
+      raise LinkemperorApiException.new('links should not be empty')
+    end
+    
+  
+    parameters = {'blast' => {'links' => links}}
+    exec_post(parameters, 'put', "#{@base_path}/api/v2/vendors/blasts/#{id}.json?api_key=#{@api_key}")
+  
+  end
+  
+  # Lists all available Services.  This is a great way to automatically compare your service against the current competition.
+  # Parameters:
+  #  none
+  def get_services()
+    
+    
+    
+  
+    exec_get("#{@base_path}/api/v2/vendors/services.json?api_key=#{@api_key}")
+  
+  end
+  
+  # Lists the full details of a specific Service.
+  # Parameters:
+  # - id: ID # of the Service
+  def get_service_by_id(id)
+    
+    
+    
+    if id.nil?
+      raise LinkemperorApiException.new('id should not be empty')
+    end
+    
+  
+    exec_get("#{@base_path}/api/v2/vendors/services/#{id}.json?api_key=#{@api_key}")
+  
+  end
+  
+  # This API method looks at all the Built URLs submitted to a given Service in the last 7 days and finds domains that have never passed our link checker.
+  # 
+  # This is a great way to clean your list of URLs used for submissions.
+  # Parameters:
+  # - id: ID # of the Service
+  def get_failed_domains(id)
+    
+    
+    
+    if id.nil?
+      raise LinkemperorApiException.new('id should not be empty')
+    end
+    
+  
+    exec_get("#{@base_path}/api/v2/vendors/services/#{id}/failed_domains.json?api_key=#{@api_key}")
+  
+  end
+  
+  # Creates a test blast for your Service.  It will not affect your score or marketplace rank.  However, if you submit URLs that fail to pass our link checker, they will be reflected in the failed_domains method of the API.
+  # 
+  # This is particularly useful for testing new URL lists or potential link sources.
+  # Parameters:
+  # - id: ID # of the Service
+  def create_test_blast(id)
+    
+    
+    
+    if id.nil?
+      raise LinkemperorApiException.new('id should not be empty')
+    end
+    
+  
+    parameters = {}
+    exec_post(parameters, 'post', "#{@base_path}/api/v2/vendors/services/#{id}/test_blast.json?api_key=#{@api_key}")
+  
+  end
+  
+end
+          

data/lib/linkemperor-api/version.rb

@@ -0,0 +1,5 @@
+module Linkemperor
+  module Api
+    VERSION = "1.0.0"
+  end
+end

data/lib/linkemperor-api.rb

@@ -0,0 +1,4 @@
+require "linkemperor-api/version"
+require "linkemperor-api/customers"
+require "linkemperor-api/vendors"
+

data/linkemperor-api.gemspec

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/linkemperor-api/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["LinkEmperor"]
+  gem.email         = ["linkemperor@linkemperor.com"]
+  gem.description   = %q{Link Emperor API for Customers and Vendors}
+  gem.summary       = %q{Link Emperor API}
+  gem.homepage      = "http://www.linkemperor.com"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "linkemperor-api"
+  gem.require_paths = ["lib"]
+  gem.version       = Linkemperor::Api::VERSION
+end

data/php/customers.php

@@ -0,0 +1,450 @@
+
+<?php
+class LinkemperorCustomer {
+  function __construct($api_key) {
+    $this->api_key = $api_key;
+    $this->base_path = 'http://app.linkemperor.com';
+  }
+  function linkemperor_exec($post_data, $method_type, $uri) {
+    $ch = curl_init();
+    curl_setopt($ch, CURLOPT_URL, $this->base_path . $uri);
+    curl_setopt($ch, CURLOPT_RETURNTRANSFER,1);
+    curl_setopt($ch, CURLOPT_USERPWD, $this->api_key . ":x");
+    curl_setopt($ch, CURLOPT_TIMEOUT, 60);
+    curl_setopt($ch, CURLOPT_HTTPHEADER, Array("Content-Type: application/json"));
+    if ($post_data) {
+      curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($post_data)); 
+    }
+    if ($method_type) {
+      curl_setopt($ch, CURLOPT_CUSTOMREQUEST, $method_type); 
+    }
+    $data = curl_exec($ch);
+    $http_code = curl_getinfo($ch, CURLINFO_HTTP_CODE);
+    if ($http_code >= 200 && $http_code < 300) {
+      if (strlen($data)) {
+        $json = json_decode($data);
+        return $json;
+      }
+      else {
+        return null;
+      }
+    }
+    else {
+      throw new Exception($data);
+    }
+  }
+
+  
+  # This method creates a new Article.
+  # Parameters:
+  # - campaign_id: Campaign ID for this Article
+  # - title: Article Title (Spintax OK)
+  # - body: Article Body (Spintax OK)
+  public function create_article($campaign_id, $title, $body) {
+    
+    
+    
+    if(!$campaign_id) {
+      throw new Exception('campaign_id should not be empty');
+    }
+    
+    if(!$title) {
+      throw new Exception('title should not be empty');
+    }
+    
+    if(!$body) {
+      throw new Exception('body should not be empty');
+    }
+    
+  
+    $parameters = array('article' => array('campaign_id' => $campaign_id, 'title' => $title, 'body' => $body));
+    return $this->linkemperor_exec($parameters, 'POST', "/api/v2/customers/articles.json");
+  
+  }
+  
+  # This method deletes the Article you specify.
+  # Parameters:
+  # - id: Article ID
+  public function delete_article($id) {
+    
+    
+    
+    if(!$id) {
+      throw new Exception('id should not be empty');
+    }
+    
+  
+    $parameters = array();
+    return $this->linkemperor_exec($parameters, 'DELETE', "/api/v2/customers/articles/$id.json");
+  
+  }
+  
+  # This method returns a list of Articles for the Campaign.
+  # Parameters:
+  # - id: Campaign ID
+  public function get_campaign_articles($id) {
+    
+    
+    
+    if(!$id) {
+      throw new Exception('id should not be empty');
+    }
+    
+  
+    return $this->linkemperor_exec(null, null,"/api/v2/customers/campaigns/$id/articles.json");
+  
+  }
+  
+  # This method returns a list of all the Blasts that exist on your account.
+  # Parameters:
+  #  none
+  public function get_blasts() {
+    
+    
+    
+  
+    return $this->linkemperor_exec(null, null,"/api/v2/customers/blasts.json");
+  
+  }
+  
+  # This method returns a details about the Blast you specify
+  # Parameters:
+  # - id: Blast ID
+  public function get_blast_by_id($id) {
+    
+    
+    
+    if(!$id) {
+      throw new Exception('id should not be empty');
+    }
+    
+  
+    return $this->linkemperor_exec(null, null,"/api/v2/customers/blasts/$id.json");
+  
+  }
+  
+  # This method returns a list of the Blasts in the Campaign.
+  # Parameters:
+  # - id: Campaign ID
+  public function get_campaign_blasts($id) {
+    
+    
+    
+    if(!$id) {
+      throw new Exception('id should not be empty');
+    }
+    
+  
+    return $this->linkemperor_exec(null, null,"/api/v2/customers/campaigns/$id/blasts.json");
+  
+  }
+  
+  # This method creates a new campaign.  Remember that if you exceed your plan limit on Campaigns, there may be additional charges.
+  # Parameters:
+  # - name: Name of the Campaign.
+  # - notes: Notes
+  public function create_campaign($name, $notes = null) {
+    
+    
+    
+    if(!$name) {
+      throw new Exception('name should not be empty');
+    }
+    
+  
+    $parameters = array('campaign' => array('name' => $name, 'notes' => $notes));
+    return $this->linkemperor_exec($parameters, 'POST', "/api/v2/customers/campaigns.json");
+  
+  }
+  
+  # This method deletes the Campaign you specify.
+  # Parameters:
+  # - id: Campaign ID
+  public function delete_campaign($id) {
+    
+    
+    
+    if(!$id) {
+      throw new Exception('id should not be empty');
+    }
+    
+  
+    $parameters = array();
+    return $this->linkemperor_exec($parameters, 'DELETE', "/api/v2/customers/campaigns/$id.json");
+  
+  }
+  
+  # This method returns a list of the Sites in the Campaign.
+  # Parameters:
+  # - id: Campaign ID
+  public function get_campaign_sites($id) {
+    
+    
+    
+    if(!$id) {
+      throw new Exception('id should not be empty');
+    }
+    
+  
+    return $this->linkemperor_exec(null, null,"/api/v2/customers/campaigns/$id/sites.json");
+  
+  }
+  
+  # This method returns a list of the Targets in the Campaign.
+  # Parameters:
+  # - id: Campaign ID
+  public function get_campaign_targets($id) {
+    
+    
+    
+    if(!$id) {
+      throw new Exception('id should not be empty');
+    }
+    
+  
+    return $this->linkemperor_exec(null, null,"/api/v2/customers/campaigns/$id/targets.json");
+  
+  }
+  
+  # This method returns a list of Trouble Spots for the Campaign.
+  # Parameters:
+  # - id: Campaign ID
+  public function get_campaign_trouble_spots($id) {
+    
+    
+    
+    if(!$id) {
+      throw new Exception('id should not be empty');
+    }
+    
+  
+    return $this->linkemperor_exec(null, null,"/api/v2/customers/campaigns/$id/trouble_spots.json");
+  
+  }
+  
+  # This method is used to purchase link building.<br /><br />
+  # We call a single purchase an Order, and each order can contain multiple Blasts.<br /><br />
+  # First, you'll need to determine which of our link building Services you'd like to order.  Use the /services endpoint of the API to get a list of available services.<br /><br />
+  # Now let's talk about building the actual order.  An OrderRequest specifies the Services to order and the Targets (URL/anchor text) to build links to.  Each Order can have multiple OrderRequests.<br /><br />
+  # You can see a sample OrderRequest (in JSON) by clicking "Model Schema" under the "Schema Used In Your Request" section just below.
+  # Parameters:
+  # - how_pay: How to pay for the Order. 'cash' to generate an invoice that will be settled against your account on file, or 'credits' to pull from the pool of existing credits in your account.
+  # - callback_url: The URL to notify when the status of the Order is updated. This occurs when component Blasts either succeed (and URLs are available for viewing) or fail (and replacement Blasts have been ordered.)
+  # - custom: You may provide any string here. We will save it as part of the Order and include it in the returned data whenever you check on an Order's status. It's great for holding your internal ID number for the Order.
+  # - requests: This is where the actual object describing your order goes.  This is either a JSON nested array or XML nested tags (depending on your current format).  The schema for this field is described below in the section titled Schema Used In Your Request.
+  public function create_order($requests, $how_pay = null, $callback_url = null, $custom = null) {
+    
+    
+    
+    if(!$requests) {
+      throw new Exception('requests should not be empty');
+    }
+    
+  
+    $parameters = array('order' => array('how_pay' => $how_pay, 'callback_url' => $callback_url, 'custom' => $custom, 'requests' => $requests));
+    return $this->linkemperor_exec($parameters, 'POST', "/api/v2/customers/orders.json");
+  
+  }
+  
+  # This method shows the details of an Order and its component Blasts.<be /><be />
+  # It's a great way to check on an order or obtain a list of Built URLs to report back to your systems.
+  # Parameters:
+  # - id: ID # of the Order
+  public function get_order_by_id($id) {
+    
+    
+    
+    if(!$id) {
+      throw new Exception('id should not be empty');
+    }
+    
+  
+    return $this->linkemperor_exec(null, null,"/api/v2/customers/orders/$id.json");
+  
+  }
+  
+  # If you're going to order link building, you need to check which Services are currently available.<br /><br />
+  # This list will change on a day-to-day or even minute-to-minute basis,
+  # so please look up the Services list to determine the best Services to order before placing an Order.<br /><br />
+  # This method returns a list of the currently available Services.
+  # Parameters:
+  #  none
+  public function get_services() {
+    
+    
+    
+  
+    return $this->linkemperor_exec(null, null,"/api/v2/customers/services.json");
+  
+  }
+  
+  # This method returns a list of the currently available Services that
+  # cdon't build links on Adult or other potentially objectional sites.
+  # Parameters:
+  #  none
+  public function get_safe_services() {
+    
+    
+    
+  
+    return $this->linkemperor_exec(null, null,"/api/v2/customers/services/safe.json");
+  
+  }
+  
+  # This method creates a new Site.
+  # Parameters:
+  # - campaign_id: Campaign ID for this Site
+  # - name: Name of this Site.
+  # - domain_name: Domain Name of this Site
+  # - rss_feed: RSS Feed for this Site
+  public function create_site($campaign_id, $name, $domain_name, $rss_feed = null) {
+    
+    
+    
+    if(!$campaign_id) {
+      throw new Exception('campaign_id should not be empty');
+    }
+    
+    if(!$name) {
+      throw new Exception('name should not be empty');
+    }
+    
+    if(!$domain_name) {
+      throw new Exception('domain_name should not be empty');
+    }
+    
+  
+    $parameters = array('site' => array('campaign_id' => $campaign_id, 'name' => $name, 'domain_name' => $domain_name, 'rss_feed' => $rss_feed));
+    return $this->linkemperor_exec($parameters, 'POST', "/api/v2/customers/sites.json");
+  
+  }
+  
+  # This method deletes the Site you specify.
+  # Parameters:
+  # - id: Site ID
+  public function delete_site($id) {
+    
+    
+    
+    if(!$id) {
+      throw new Exception('id should not be empty');
+    }
+    
+  
+    $parameters = array();
+    return $this->linkemperor_exec($parameters, 'DELETE', "/api/v2/customers/sites/$id.json");
+  
+  }
+  
+  # This method creates a new Target.  You will need to provide a Campaign ID and a URL for the target.
+  # Parameters:
+  # - campaign_id: Campaign ID
+  # - url_input: Fully qualified URL for the target.
+  # - keyword_input: Keywords to add to the target.  Separate multiple keywords with linebreaks.
+  public function create_target($campaign_id, $url_input, $keyword_input = null) {
+    
+    
+    
+    if(!$campaign_id) {
+      throw new Exception('campaign_id should not be empty');
+    }
+    
+    if(!$url_input) {
+      throw new Exception('url_input should not be empty');
+    }
+    
+  
+    $parameters = array('target' => array('campaign_id' => $campaign_id, 'url_input' => $url_input, 'keyword_input' => $keyword_input));
+    return $this->linkemperor_exec($parameters, 'POST', "/api/v2/customers/targets.json");
+  
+  }
+  
+  # This method deletes the Target you specify.
+  # Parameters:
+  # - id: Target ID
+  public function delete_target($id) {
+    
+    
+    
+    if(!$id) {
+      throw new Exception('id should not be empty');
+    }
+    
+  
+    $parameters = array();
+    return $this->linkemperor_exec($parameters, 'DELETE', "/api/v2/customers/targets/$id.json");
+  
+  }
+  
+  # This method creates a new Keyword.  You will need to provide a Target ID.
+  # Parameters:
+  # - target_id: Target ID
+  # - keyword_string: Keyword string
+  public function create_target_keyword($target_id, $keyword_string) {
+    
+    
+    
+    if(!$target_id) {
+      throw new Exception('target_id should not be empty');
+    }
+    
+    if(!$keyword_string) {
+      throw new Exception('keyword_string should not be empty');
+    }
+    
+  
+    $parameters = array('target_keyword' => array('target_id' => $target_id, 'keyword_string' => $keyword_string));
+    return $this->linkemperor_exec($parameters, 'POST', "/api/v2/customers/target_keywords.json");
+  
+  }
+  
+  # This method deletes the Keyword you specify.
+  # Parameters:
+  # - id: Keyword ID
+  public function delete_target_keyword($id) {
+    
+    
+    
+    if(!$id) {
+      throw new Exception('id should not be empty');
+    }
+    
+  
+    $parameters = array();
+    return $this->linkemperor_exec($parameters, 'DELETE', "/api/v2/customers/target_keywords/$id.json");
+  
+  }
+  
+  # This method returns a list of all the Trouble Spots that exist on your account.
+  # 
+  # Trouble Spots are issues spotted by our On-Page SEO Checker for Campaigns.
+  # Parameters:
+  #  none
+  public function get_trouble_spots() {
+    
+    
+    
+  
+    return $this->linkemperor_exec(null, null,"/api/v2/customers/trouble_spots.json");
+  
+  }
+  
+  # This method returns details about the Trouble Spot you specify.
+  # Parameters:
+  # - id: TroubleSpot ID
+  public function get_trouble_spot_by_id($id) {
+    
+    
+    
+    if(!$id) {
+      throw new Exception('id should not be empty');
+    }
+    
+  
+    return $this->linkemperor_exec(null, null,"/api/v2/customers/trouble_spots/$id.json");
+  
+  }
+  
+}
+?>
+