diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..2251a19 --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +.pydevproject +.project diff --git a/_build/doctrees/api.doctree b/_build/doctrees/api.doctree new file mode 100644 index 0000000..cc3f241 Binary files /dev/null and b/_build/doctrees/api.doctree differ diff --git a/_build/doctrees/environment.pickle b/_build/doctrees/environment.pickle index b5e4fe7..87f4c62 100644 Binary files a/_build/doctrees/environment.pickle and b/_build/doctrees/environment.pickle differ diff --git a/_build/doctrees/index.doctree b/_build/doctrees/index.doctree index de29b58..b04d93c 100644 Binary files a/_build/doctrees/index.doctree and b/_build/doctrees/index.doctree differ diff --git a/_build/doctrees/installation.doctree b/_build/doctrees/installation.doctree new file mode 100644 index 0000000..3275fc6 Binary files /dev/null and b/_build/doctrees/installation.doctree differ diff --git a/_build/doctrees/support.doctree b/_build/doctrees/support.doctree new file mode 100644 index 0000000..1cfb7f2 Binary files /dev/null and b/_build/doctrees/support.doctree differ diff --git a/_build/doctrees/usage.doctree b/_build/doctrees/usage.doctree new file mode 100644 index 0000000..bc6e082 Binary files /dev/null and b/_build/doctrees/usage.doctree differ diff --git a/_build/html/_images/sp_api_settings.png b/_build/html/_images/sp_api_settings.png new file mode 100644 index 0000000..f067ace Binary files /dev/null and b/_build/html/_images/sp_api_settings.png differ diff --git a/_build/html/_sources/api.txt b/_build/html/_sources/api.txt new file mode 100644 index 0000000..31f1585 --- /dev/null +++ b/_build/html/_sources/api.txt @@ -0,0 +1,307 @@ +3. API +====================== + +The Seo Panel API provides an interface to allow you to access and perform actions +in Seo Panel both from external applications and scripts as well as internal modules and addons. + +The Seo Panel API supports response type: JSON + +1. API Setup +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Login as admin and go to following page + +Admin Panel => API Manager => API Settings + +Change values of API Key and Secret for security according to the below screen shot. + +.. image:: _static/sp_api_settings.png + + +2. Functions +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The API currently supports the following functions + + +Website Management +------------------ + +Add Website +************************ + +**Purpose** + +This command is used to add a new website in seo panel. + +**Attributes** + - name => The name of the website + - url => The url of the website + - user_id => The user id of website + +**Optional Attributes** + + - title => The title of the website + - description => The description of website + - keywords => The keyword of the website + - status => The status of the website - default[1] + +**Example Command** + + $postfields["action"] = "createWebsite"; + +**Successful Response** + +result = success +message = xxx - returned on error +clientid = returned ID of newly added Client + +**Error Response** + +result=error&message= + + + + +Update Website +************************ + +**Purpose** + +**Attributes** + +**Optional Attributes** + +**Example Command** + +**Successful Response** + +**Error Response** + + +Delete Website +************************ + + +**Purpose** + +**Attributes** + +**Optional Attributes** + +**Example Command** + +**Successful Response** + +**Error Response** + + +Get Website Details +************************ + + +**Purpose** + +**Attributes** + +**Optional Attributes** + +**Example Command** + +**Successful Response** + +**Error Response** + + +Get Website Reports +************************ + + +**Purpose** + +**Attributes** + +**Optional Attributes** + +**Example Command** + +**Successful Response** + +**Error Response** + + +Get User Website Reports +************************ + +**Purpose** + +**Attributes** + +**Optional Attributes** + +**Example Command** + +**Successful Response** + +**Error Response** + + +Keyword Management +------------------ + +Add Keyword +************************ + + +**Purpose** + +**Attributes** + +**Optional Attributes** + +**Example Command** + +**Successful Response** + +**Error Response** + + +Update Keyword +************************ + +**Purpose** + +**Attributes** + +**Optional Attributes** + +**Example Command** + +**Successful Response** + +**Error Response** + +Delete Keyword +************************ + +**Purpose** + +**Attributes** + +**Optional Attributes** + +**Example Command** + +**Successful Response** + +**Error Response** + +Get Keyword Details +************************ + +**Purpose** + +**Attributes** + +**Optional Attributes** + +**Example Command** + +**Successful Response** + +**Error Response** + +Get Keyword Reports +************************ + +**Purpose** + +**Attributes** + +**Optional Attributes** + +**Example Command** + +**Successful Response** + +**Error Response** + +Get Website Keyword Reports +*************************** + +**Purpose** + +**Attributes** + +**Optional Attributes** + +**Example Command** + +**Successful Response** + +**Error Response** + +Get User Keyword Reports +************************ + +**Purpose** + +**Attributes** + +**Optional Attributes** + +**Example Command** + +**Successful Response** + +**Error Response** + + +User Management +------------------ + +Add User +************************ + +**Purpose** + +**Attributes** + +**Optional Attributes** + +**Example Command** + +**Successful Response** + +**Error Response** + +Update User +************************ + +**Purpose** + +**Attributes** + +**Optional Attributes** + +**Example Command** + +**Successful Response** + +**Error Response** + +Delete User +************************ + +**Purpose** + +**Attributes** + +**Optional Attributes** + +**Example Command** + +**Successful Response** + +**Error Response** + diff --git a/_build/html/_sources/index.txt b/_build/html/_sources/index.txt index f050a5b..e38068f 100644 --- a/_build/html/_sources/index.txt +++ b/_build/html/_sources/index.txt @@ -3,20 +3,35 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -Welcome to Seo Panel Docs's documentation! -========================================== -Contents: +Seo Panel Documentation +===================== .. toctree:: - :maxdepth: 2 + :maxdepth: 3 + installation + usage + support + api +.. references -Indices and tables -================== -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` +Contents +======== + +This document covers the installation, usage, api guides for Seo Panel. + +The latest version of this guide can be obtained from http://www.seopanel.in/docs/ + +A live demo of seo panel is available at http://demo.seopanel.in/ + +You can interact with the seo panel user community at http://forum.seopanel.in + +Contact us for additional support via http://www.seopanel.in/contact/ + +**References:** + - http://www.seopanel.in/ + diff --git a/_build/html/_sources/installation.txt b/_build/html/_sources/installation.txt new file mode 100644 index 0000000..878c03c --- /dev/null +++ b/_build/html/_sources/installation.txt @@ -0,0 +1,2 @@ +1. INSTALLATION +====================== \ No newline at end of file diff --git a/_build/html/_sources/support.txt b/_build/html/_sources/support.txt new file mode 100644 index 0000000..58e15e4 --- /dev/null +++ b/_build/html/_sources/support.txt @@ -0,0 +1,2 @@ +4. SUPPORT +====================== \ No newline at end of file diff --git a/_build/html/_sources/usage.txt b/_build/html/_sources/usage.txt new file mode 100644 index 0000000..bedba25 --- /dev/null +++ b/_build/html/_sources/usage.txt @@ -0,0 +1,2 @@ +2. USAGE GUIDE +====================== \ No newline at end of file diff --git a/_build/html/_static/sp_api_settings.png b/_build/html/_static/sp_api_settings.png new file mode 100644 index 0000000..f067ace Binary files /dev/null and b/_build/html/_static/sp_api_settings.png differ diff --git a/_build/html/api.html b/_build/html/api.html new file mode 100644 index 0000000..36aecc4 --- /dev/null +++ b/_build/html/api.html @@ -0,0 +1,331 @@ + + + + + + + + 3. API — Seo Panel Docs 3.7.0 documentation + + + + + + + + + + + + + + + + + + +
+
+
+
+ +
+

3. API

+

The Seo Panel API provides an interface to allow you to access and perform actions +in Seo Panel both from external applications and scripts as well as internal modules and addons.

+

The Seo Panel API supports response type: JSON

+
+

1. API Setup

+

Login as admin and go to following page

+

Admin Panel => API Manager => API Settings

+

Change values of API Key and Secret for security according to the below screen shot.

+_images/sp_api_settings.png +
+
+

2. Functions

+

The API currently supports the following functions

+
+

Website Management

+
+

Add Website

+

Purpose

+

This command is used to add a new website in seo panel.

+
+
Attributes
+
    +
  • name => The name of the website
  • +
  • url => The url of the website
  • +
  • user_id => The user id of website
  • +
+
+
+

Optional Attributes

+
+
    +
  • title => The title of the website
  • +
  • description => The description of website
  • +
  • keywords => The keyword of the website
  • +
  • status => The status of the website - default[1]
  • +
+
+

Example Command

+
+
$postfields[“action”] = “createWebsite”;
+

Successful Response

+

result = success +message = xxx - returned on error +clientid = returned ID of newly added Client

+

Error Response

+

result=error&message=

+
+
+

Update Website

+

Purpose

+

Attributes

+

Optional Attributes

+

Example Command

+

Successful Response

+

Error Response

+
+
+

Delete Website

+

Purpose

+

Attributes

+

Optional Attributes

+

Example Command

+

Successful Response

+

Error Response

+
+
+

Get Website Details

+

Purpose

+

Attributes

+

Optional Attributes

+

Example Command

+

Successful Response

+

Error Response

+
+
+

Get Website Reports

+

Purpose

+

Attributes

+

Optional Attributes

+

Example Command

+

Successful Response

+

Error Response

+
+
+

Get User Website Reports

+

Purpose

+

Attributes

+

Optional Attributes

+

Example Command

+

Successful Response

+

Error Response

+
+
+
+

Keyword Management

+
+

Add Keyword

+

Purpose

+

Attributes

+

Optional Attributes

+

Example Command

+

Successful Response

+

Error Response

+
+
+

Update Keyword

+

Purpose

+

Attributes

+

Optional Attributes

+

Example Command

+

Successful Response

+

Error Response

+
+
+

Delete Keyword

+

Purpose

+

Attributes

+

Optional Attributes

+

Example Command

+

Successful Response

+

Error Response

+
+
+

Get Keyword Details

+

Purpose

+

Attributes

+

Optional Attributes

+

Example Command

+

Successful Response

+

Error Response

+
+
+

Get Keyword Reports

+

Purpose

+

Attributes

+

Optional Attributes

+

Example Command

+

Successful Response

+

Error Response

+
+
+

Get Website Keyword Reports

+

Purpose

+

Attributes

+

Optional Attributes

+

Example Command

+

Successful Response

+

Error Response

+
+
+

Get User Keyword Reports

+

Purpose

+

Attributes

+

Optional Attributes

+

Example Command

+

Successful Response

+

Error Response

+
+
+
+

User Management

+
+

Add User

+

Purpose

+

Attributes

+

Optional Attributes

+

Example Command

+

Successful Response

+

Error Response

+
+
+

Update User

+

Purpose

+

Attributes

+

Optional Attributes

+

Example Command

+

Successful Response

+

Error Response

+
+
+

Delete User

+

Purpose

+

Attributes

+

Optional Attributes

+

Example Command

+

Successful Response

+

Error Response

+
+
+
+
+ + +
+
+
+ +
+
+ + + + + + + \ No newline at end of file diff --git a/_build/html/index.html b/_build/html/index.html index 396a72a..eb1f4c5 100644 --- a/_build/html/index.html +++ b/_build/html/index.html @@ -6,7 +6,7 @@ - Welcome to Seo Panel Docs’s documentation! — Seo Panel Docs 3.7.0 documentation + Seo Panel Documentation — Seo Panel Docs 3.7.0 documentation @@ -24,6 +24,7 @@ + @@ -36,6 +37,9 @@

Navigation

  • index
  • +
  • + next |
  • @@ -45,21 +49,40 @@

    Navigation

    -
    -

    Welcome to Seo Panel Docs’s documentation!

    -

    Contents:

    + -
    -

    Indices and tables

    -
      -
    • Index
    • -
    • Module Index
    • -
    • Search Page
    • +
      +

      Contents

      +

      This document covers the installation, usage, api guides for Seo Panel.

      +

      The latest version of this guide can be obtained from http://www.seopanel.in/docs/

      +

      A live demo of seo panel is available at http://demo.seopanel.in/

      +

      You can interact with the seo panel user community at http://forum.seopanel.in

      +

      Contact us for additional support via http://www.seopanel.in/contact/

      +
      +
      References:
      +
      +
      +
      @@ -70,10 +93,13 @@

      Indices and tables

      Table Of Contents

      +

      Next topic

      +

      1. INSTALLATION

      This Page

        diff --git a/_build/html/installation.html b/_build/html/installation.html new file mode 100644 index 0000000..f4399e7 --- /dev/null +++ b/_build/html/installation.html @@ -0,0 +1,112 @@ + + + + + + + + 1. INSTALLATION — Seo Panel Docs 3.7.0 documentation + + + + + + + + + + + + + + + + + + + +
        +
        +
        +
        + +
        +

        1. INSTALLATION

        +
        + + +
        +
        +
        + +
        +
        + + + + + + + \ No newline at end of file diff --git a/_build/html/searchindex.js b/_build/html/searchindex.js index ce3398c..3e645a4 100644 --- a/_build/html/searchindex.js +++ b/_build/html/searchindex.js @@ -1 +1 @@ -Search.setIndex({envversion:46,filenames:["index"],objects:{},objnames:{},objtypes:{},terms:{content:0,index:0,modul:0,page:0,search:0},titles:["Welcome to Seo Panel Docs’s documentation!"],titleterms:{doc:0,document:0,indic:0,panel:0,seo:0,tabl:0,welcom:0}}) \ No newline at end of file +Search.setIndex({envversion:46,filenames:["api","index","installation","support","usage"],objects:{},objnames:{},objtypes:{},terms:{"default":0,"new":0,"return":0,"true":[],ab123:[],access:0,accord:0,account:[],action:0,add:[],addclient:[],addit:1,addon:0,address1:[],address2:[],address:[],admin:0,allow:0,answer:[],api:[],applic:0,arrai:[],assign:[],avail:1,base64:[],base64_encod:[],below:0,both:0,can:1,cardnum:[],cctype:[],chang:0,check:[],citi:[],client:0,clientid:0,clientip:[],code:[],com:[],commun:1,companynam:[],contact:1,content:[],countri:[],cover:1,createwebsit:0,currenc:[],current:0,custom:[],customfield:[],delet:[],demo:1,descript:0,detail:[],email:[],encod:[],etc:[],expdat:[],extern:0,field:[],firstnam:[],florida:[],follow:0,format:[],forum:1,from:[0,1],get:[],googl:[],group:[],groupid:[],guid:[],http:1,index:[],instal:[],interact:1,interfac:0,intern:0,iso:[],issuenumb:[],json:0,kei:0,languag:[],lastnam:[],latest:1,letter:[],live:1,login:0,manag:[],mandatori:[],mastercard:[],messag:0,mmyi:[],modul:0,name:0,newli:0,noemail:[],note:[],obtain:1,page:0,pass:[],password2:[],password:[],perform:0,phonenumb:[],postcod:[],postfield:0,provid:0,question:[],refer:1,report:[],requir:[],respons:[],result:0,screen:0,script:0,search:[],secret:0,secur:0,securityqan:[],securityqid:[],send:[],seopanel:1,seopnael:[],serial:[],set:0,shot:0,signup:[],skipvalid:[],startdat:[],state:[],statu:0,street:[],support:[],surpress:[],system:[],test:[],thi:[0,1],titl:0,two:[],type:0,updat:[],url:0,usag:[],user:[],user_id:0,valid:[],valu:0,version:1,via:1,visa:[],well:0,whmc:[],www:1,xxx:0,you:[0,1],your:[]},titles:["3. API","Seo Panel Documentation","1. INSTALLATION","4. SUPPORT","2. USAGE GUIDE"],titleterms:{"function":0,add:0,api:0,attribut:[],command:[],content:1,delet:0,detail:0,doc:[],document:1,error:[],exampl:[],get:0,guid:4,indic:[],instal:2,keyword:0,manag:0,option:[],panel:1,purpos:[],report:0,respons:[],seo:1,setup:0,success:[],support:3,tabl:[],updat:0,usag:4,user:0,websit:0,welcom:[]}}) \ No newline at end of file diff --git a/_build/html/support.html b/_build/html/support.html new file mode 100644 index 0000000..7137f78 --- /dev/null +++ b/_build/html/support.html @@ -0,0 +1,112 @@ + + + + + + + + 4. SUPPORT — Seo Panel Docs 3.7.0 documentation + + + + + + + + + + + + + + + + + + + +
        +
        +
        +
        + +
        +

        4. SUPPORT

        +
        + + +
        +
        +
        + +
        +
        + + + + + + + \ No newline at end of file diff --git a/_build/html/usage.html b/_build/html/usage.html new file mode 100644 index 0000000..6d69611 --- /dev/null +++ b/_build/html/usage.html @@ -0,0 +1,112 @@ + + + + + + + + 2. USAGE GUIDE — Seo Panel Docs 3.7.0 documentation + + + + + + + + + + + + + + + + + + + +
        +
        +
        +
        + +
        +

        2. USAGE GUIDE

        +
        + + +
        +
        +
        + +
        +
        + + + + + + + \ No newline at end of file diff --git a/_static/sp_api_settings.png b/_static/sp_api_settings.png new file mode 100644 index 0000000..f067ace Binary files /dev/null and b/_static/sp_api_settings.png differ diff --git a/api.rst b/api.rst new file mode 100644 index 0000000..31f1585 --- /dev/null +++ b/api.rst @@ -0,0 +1,307 @@ +3. API +====================== + +The Seo Panel API provides an interface to allow you to access and perform actions +in Seo Panel both from external applications and scripts as well as internal modules and addons. + +The Seo Panel API supports response type: JSON + +1. API Setup +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Login as admin and go to following page + +Admin Panel => API Manager => API Settings + +Change values of API Key and Secret for security according to the below screen shot. + +.. image:: _static/sp_api_settings.png + + +2. Functions +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The API currently supports the following functions + + +Website Management +------------------ + +Add Website +************************ + +**Purpose** + +This command is used to add a new website in seo panel. + +**Attributes** + - name => The name of the website + - url => The url of the website + - user_id => The user id of website + +**Optional Attributes** + + - title => The title of the website + - description => The description of website + - keywords => The keyword of the website + - status => The status of the website - default[1] + +**Example Command** + + $postfields["action"] = "createWebsite"; + +**Successful Response** + +result = success +message = xxx - returned on error +clientid = returned ID of newly added Client + +**Error Response** + +result=error&message= + + + + +Update Website +************************ + +**Purpose** + +**Attributes** + +**Optional Attributes** + +**Example Command** + +**Successful Response** + +**Error Response** + + +Delete Website +************************ + + +**Purpose** + +**Attributes** + +**Optional Attributes** + +**Example Command** + +**Successful Response** + +**Error Response** + + +Get Website Details +************************ + + +**Purpose** + +**Attributes** + +**Optional Attributes** + +**Example Command** + +**Successful Response** + +**Error Response** + + +Get Website Reports +************************ + + +**Purpose** + +**Attributes** + +**Optional Attributes** + +**Example Command** + +**Successful Response** + +**Error Response** + + +Get User Website Reports +************************ + +**Purpose** + +**Attributes** + +**Optional Attributes** + +**Example Command** + +**Successful Response** + +**Error Response** + + +Keyword Management +------------------ + +Add Keyword +************************ + + +**Purpose** + +**Attributes** + +**Optional Attributes** + +**Example Command** + +**Successful Response** + +**Error Response** + + +Update Keyword +************************ + +**Purpose** + +**Attributes** + +**Optional Attributes** + +**Example Command** + +**Successful Response** + +**Error Response** + +Delete Keyword +************************ + +**Purpose** + +**Attributes** + +**Optional Attributes** + +**Example Command** + +**Successful Response** + +**Error Response** + +Get Keyword Details +************************ + +**Purpose** + +**Attributes** + +**Optional Attributes** + +**Example Command** + +**Successful Response** + +**Error Response** + +Get Keyword Reports +************************ + +**Purpose** + +**Attributes** + +**Optional Attributes** + +**Example Command** + +**Successful Response** + +**Error Response** + +Get Website Keyword Reports +*************************** + +**Purpose** + +**Attributes** + +**Optional Attributes** + +**Example Command** + +**Successful Response** + +**Error Response** + +Get User Keyword Reports +************************ + +**Purpose** + +**Attributes** + +**Optional Attributes** + +**Example Command** + +**Successful Response** + +**Error Response** + + +User Management +------------------ + +Add User +************************ + +**Purpose** + +**Attributes** + +**Optional Attributes** + +**Example Command** + +**Successful Response** + +**Error Response** + +Update User +************************ + +**Purpose** + +**Attributes** + +**Optional Attributes** + +**Example Command** + +**Successful Response** + +**Error Response** + +Delete User +************************ + +**Purpose** + +**Attributes** + +**Optional Attributes** + +**Example Command** + +**Successful Response** + +**Error Response** + diff --git a/index.rst b/index.rst index 7b95ce4..e38068f 100644 --- a/index.rst +++ b/index.rst @@ -23,13 +23,13 @@ Contents This document covers the installation, usage, api guides for Seo Panel. -The latest version of this guide can be obtained from http://www.seopanel.in/docs +The latest version of this guide can be obtained from http://www.seopanel.in/docs/ -A live demo of seo panel is available at http://demo.seopanel.in +A live demo of seo panel is available at http://demo.seopanel.in/ -You can interact with the seo panel user community at http://forum.seopnael.in +You can interact with the seo panel user community at http://forum.seopanel.in -Contact us for additional support via http://www.seopanel.in/contact +Contact us for additional support via http://www.seopanel.in/contact/ **References:** - http://www.seopanel.in/ diff --git a/installation.rst b/installation.rst new file mode 100644 index 0000000..878c03c --- /dev/null +++ b/installation.rst @@ -0,0 +1,2 @@ +1. INSTALLATION +====================== \ No newline at end of file diff --git a/modindex.srt b/modindex.srt new file mode 100644 index 0000000..6a9769b --- /dev/null +++ b/modindex.srt @@ -0,0 +1,17 @@ +.. Seo Panel Docs documentation master file, created by + sphinx-quickstart on Mon Jun 8 00:36:28 2015. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to Seo Panel Docs's documentation! +========================================== + +Contents: + +.. toctree:: + :maxdepth: 2 + + + + + diff --git a/support.rst b/support.rst new file mode 100644 index 0000000..58e15e4 --- /dev/null +++ b/support.rst @@ -0,0 +1,2 @@ +4. SUPPORT +====================== \ No newline at end of file diff --git a/usage.rst b/usage.rst new file mode 100644 index 0000000..bedba25 --- /dev/null +++ b/usage.rst @@ -0,0 +1,2 @@ +2. USAGE GUIDE +====================== \ No newline at end of file