From 2ea5de81147def774efeac2ed1c4b92b1aee9dc3 Mon Sep 17 00:00:00 2001 From: maj-hamzahk Date: Wed, 25 Oct 2017 14:58:03 +0100 Subject: [PATCH 1/4] modified samples/pom.xml --- samples/pom.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/samples/pom.xml b/samples/pom.xml index 047ec7f..c8bc3a7 100644 --- a/samples/pom.xml +++ b/samples/pom.xml @@ -38,7 +38,7 @@ com.majesticseo.external.rpc majesticseo-external-rpc - 0.9.5 + 0.9.6-SNAPSHOT jar From 48e46c788f077750cfa462fa5bf92bb42059b5bc Mon Sep 17 00:00:00 2001 From: maj-hamzahk <32493853+maj-hamzahk@users.noreply.github.com> Date: Wed, 25 Oct 2017 17:11:43 +0100 Subject: [PATCH 2/4] primitive change(need to update later) --- README.md | 47 +++++++++++++++++++++++++++++++++++++++++++---- 1 file changed, 43 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 0872cd2..7af30d0 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,36 @@ -Java Majestic API Connector -=========================== +JAVA-API-Connector +==================== + + +Use the https://majestic.com connectors to access web data from one of the largest web indexes available. +The Majestic® search engine is mainly used to instantly provide Flow Metrics® which evaluate the any page on the Internet in scores between 0 and 100. + + +For set up(note: the following has only been tested in Windows) +--------------- + +Clone the repository in a directory.\ + +navaigate to the src folder and run the flowing from your terminal: + +``` +mvn install +``` +After that navigate into samples and run: +``` +mvn package +``` + +To run the samples you'll need mutiple jars run the following from the JAVA-API-connector directory +``` +java -cp "src\target\majesticseo-external-rpc-0.9.6-SNAPSHOT.jar;samples\target\sample-0.9.5.jar" com.majesticseo.external.rpc.sample.GetIndexItemInfo +``` + + +Examples +------------- + -The Java connector targets the 1.5 language specification, and is built using Maven. ```Java APIService api = new APIService("MY_API_KEY", "https://api.majestic.com/api_command"); @@ -26,4 +55,14 @@ else } ``` -A full list of available commands can be found within the [developer documentation](https://developer-support.majestic.com/api/commands/). \ No newline at end of file +A full list of available commands can be found within the [developer documentation](https://developer-support.majestic.com/api/commands/). + + + +Further notes +------------------ + +The Java connector targets the 1.5 language specification, and is built using Maven. + + +For further information see api documentation @ https://developer-support.majestic.com/ From 5f776d8b38f47739717e7d7ae8389cd76bc367c9 Mon Sep 17 00:00:00 2001 From: maj-hamzahk <32493853+maj-hamzahk@users.noreply.github.com> Date: Thu, 26 Oct 2017 11:58:13 +0100 Subject: [PATCH 3/4] touched up README.md awaiting review --- README.md | 25 ++++++++++++++----------- 1 file changed, 14 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 7af30d0..0c80a23 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,14 @@ JAVA-API-Connector ==================== - Use the https://majestic.com connectors to access web data from one of the largest web indexes available. The Majestic® search engine is mainly used to instantly provide Flow Metrics® which evaluate the any page on the Internet in scores between 0 and 100. For set up(note: the following has only been tested in Windows) ---------------- +---------------------------------------------------------------- -Clone the repository in a directory.\ +Clone the repository in a directory. navaigate to the src folder and run the flowing from your terminal: @@ -21,7 +20,9 @@ After that navigate into samples and run: mvn package ``` -To run the samples you'll need mutiple jars run the following from the JAVA-API-connector directory +Now that this is done the samples should be compiled into a single jar in the target folder of the samples. +To run a specified sample you will need to run the following from the JAVA-API-Connetors directory: + ``` java -cp "src\target\majesticseo-external-rpc-0.9.6-SNAPSHOT.jar;samples\target\sample-0.9.5.jar" com.majesticseo.external.rpc.sample.GetIndexItemInfo ``` @@ -29,9 +30,14 @@ java -cp "src\target\majesticseo-external-rpc-0.9.6-SNAPSHOT.jar;samples\target\ Examples ------------- - - - +There are a few examples of using the API-Connector by the Jar, use the following commands: + +* GetIndexItemInfo + * The GetIndexItemInfo command provides data on the number of backlinks to any web page or site, linking domains and the main topics for that page or web site +* GetBackLinkData + * GetBacklinkData will return rows of data with information about all the pages linking to a given URL or domain + +The follwoing code is from GetIndexItemInfo.java, it will shows how the API-Connector can be used. ```Java APIService api = new APIService("MY_API_KEY", "https://api.majestic.com/api_command"); @@ -55,14 +61,11 @@ else } ``` -A full list of available commands can be found within the [developer documentation](https://developer-support.majestic.com/api/commands/). - - - Further notes ------------------ The Java connector targets the 1.5 language specification, and is built using Maven. +A full list of available commands can be found within the [developer documentation](https://developer-support.majestic.com/api/commands/). For further information see api documentation @ https://developer-support.majestic.com/ From 42b980295653587fb01bb1f196ad61e68287ad9e Mon Sep 17 00:00:00 2001 From: maj-hamzahk <32493853+maj-hamzahk@users.noreply.github.com> Date: Thu, 26 Oct 2017 12:32:27 +0100 Subject: [PATCH 4/4] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 0c80a23..13b1dad 100644 --- a/README.md +++ b/README.md @@ -34,7 +34,7 @@ There are a few examples of using the API-Connector by the Jar, use the followin * GetIndexItemInfo * The GetIndexItemInfo command provides data on the number of backlinks to any web page or site, linking domains and the main topics for that page or web site -* GetBackLinkData +* GetTopBackLinks * GetBacklinkData will return rows of data with information about all the pages linking to a given URL or domain The follwoing code is from GetIndexItemInfo.java, it will shows how the API-Connector can be used.