VerifyAccess

This function verifies that the PBwiki API system is working properly and that your API key is valid.

This should be the first function you code against to ensure your script will function properly. If VerifyAccess fails, you should not make further calls to the PBwiki API. You may periodically retry VerifyAccess up to once a minute until the service comes up again, but please don't overload our system with constant retries or we may have to disable your access.

Request Parameters

There are no extra parameters to the VerifyAccess call.

Responses

If the system is up, you will get a "status" set to "OK". Any other status message than "OK" should be interpreted as a failure and you should read the message before proceeding.

You will also get back "functionList", which is an array of functions you can call with the key you have presented. Do not call functions not listed here or your script may be banned. Note that the function names may be returned in lowercase; while parameters are case-sensitive, function names are not.

Example

REQUEST

RESPONSE

{ "v1": {
  "status": "OK",
  "functionList": [ "VerifyAccess", "GetPage", "GetPageInfo" ]
}}

 Create your own business wiki!Support CommunityPublic, Platinum wiki Privacy Policy RSS