It’s your choice!

23 Gloria Street

               Uxbridge, Ma. 01569-1342

                      Phone (508) 278-8036

                             Fax (508) 278-8036

        Email: sales@webblock.net

 

WebBlock SDK:

 

 

WebBlock supplies a Software Developer Kit (SDK) SERVLET for companies who want to supplement or embrace WebBlock’s rating system.

 

The concept is simple. The client issues a HTTP POST call to WebBlock’s SDK SERVLET which in turn verifies the website in the database.

 

The client application can request a status return flag (default) or have WebBlock issue a re-direct on the URL. The re-direct sends the contents of the passed URL back to the calling client or the contents of a pre-defined error page.

 

The client application can also pass the good and bad ratings flags along with the HTTP POST call or let WebBlock look up the flags in the third party’s account.

 

Client Parameters:

 

Mandatory:

 

NBURL: The URL to be checked.

                Example:  NBURL=www.mywebsite.com

NBCID:  The third-party integrators ID. Assigned by WebBlock.

                Example:  NBCID=999

 

Optional:

NBRET:  The default is to let WebBlock return a status code back to the client. After inspecting the status code the client can take appropriate action.

However, if the client wants WebBlock to take the URL or error page and send back the actual results of the web site, then specify NBRET=1

Note that the default redirect is HTTP as opposed to HTTPS. (See parameter NBSEC)

 

NBBLOCK:

            You may issue your clients ratings for rejection sites.

            Example: NBBLOCK=”D,H,I,X”

 

            This informs WebBlock to reject the NBURL if it is classified as Date, Hate, Illegal or X-rated site. (Adult)

 

Note that NBPASS and NBBLOCK must be unique. WebBlock will check for this.

If you do not issue an NBBLOCK, the ratings specified in your WebBlock account will take effect.

 

 

 

 

NBPASS:

            You may issue your clients ratings for pass sites.

            Example: NBPASS=”A,G,K,N”

 

            This informs WebBlock to pass the NBURL if it is classified as Auction, Gambling, Kids or Newsgroups.

 

Note that NBPASS and NBBLOCK must be unique. WebBlock will check for this.

If you do not issue a NBPASS the ratings specified in your WebBlock account will take effect.

 

NBSEC:

            If NBRET is specified, then WebBlock can re-direct the URL using HTTP or HTTPS (secure protocol). The default is to issue a HTTP, but there are some occasions when a HTTPS is needed.

 

 

Return flags:

 

NB_ACCOUNT_EXPIRED  = 9000

            Account that references NBCID has expired. Please contact WebBlock.

 

NB_ACCOUNT_NOTFOUND = 9001

            Account that references NBCID was not found. Please contact WebBlock.

 

NB_ACCOUNT_RATINGS_ERROR = 9002

            You have duplicated a rating in the parameters NBPASS OR NBBLOCK. Both parameters must be unique.

 

NB_ACCOUNT_CONNECTION_REFUSED = 9003

            The database connection could not be opened.

NB_ACCOUNT_ILLEGAL_URL=9004

            WebBlock checks the parameter NBURL against certain criteria. An example would be a value that starts with a disk drive letter like c:\ or if the value is blank.

 

 

SC_OK = 200

            NBURL was found in the database, with an assigned rating and was passed or as been previously visited.

 

SC_UNAUTHORIZED = 401

            The account pointed to by NBCID has been disabled. This is a feature where you can close down all connections.

 

SC_FORBIDDEN = 403

            The site pointed to by NBURL has failed against a rating of NBBLOCK or one set in the database.

 

SC_NOT_FOUND=404

            The site pointed to by NBURL was not found in the WebBlock database and has no rating attached to it.

 

Examples:

 

http://www.webblock/com/netBlock/sdk?NBURL=”www.hotmail.com”&NBCID=666

 

http://www.webblock/com/netBlock/sdk?NBURL=”www.hotmail.com”&NBCID=666& NBBLOCK=”D,H,I,X”&NBPASS=”A,G,K,N”

 

The 2 examples above will return a status code. One uses the ratings in the WebBlock database; the other overrides the ratings by passing them in the URL.

 

http://www.webblock/com/netBlock/sdk?NBURL=”www.hotmail.com”&NBCID=666&NBRET=1

 

Return the actual web site’s contents, using a protocol of HTTP.

 

http://www.webblock/com/netBlock/sdk?NBURL=”www.hotmail.com”&NBCID=666& NBBLOCK=”D,H,I,X”&NBPASS=”A,G,K,N”&NBRET=1&NBSEC=1

 

Return the actual web site’s contents, using a protocol of HTTPS.

 

 

Note that if you duplicate a rating in both the NBPASS and NBBLOCK, a STATUS code is ALWAYS returned regardless of the NBRET flag.