The API plugin provides the ability for remote servers to communicate with your Jomres server and perform certain functionality.

 

When you install the API plugin a new button is added to the administrator's control panel. This button contains a log of API transactions and is formatted in a number of columns :

 

 

Status

 

Did the transaction complete successfully? If not, this first icon will show one of several possible icons, which are noted in the legend at the bottom of the page :

 

Transaction completed successfully

Transaction completed successfully, but the script reported an error.

Transaction was did not complete due to an API key failure.

Transaction blocked due to previous API key failures.

Transaction failed due to system error.

 

This finishing status is mainly concerned with authentication of the calling transaction. It is not concerned with whether or not the API was able to perform whatever action was requested by the remote server.

 

Transaction details

 

If you hover over a cell in this column you will see a javascript popup which gives details of the information requested, and the xml data that was passed back as a result of this call.

 

IP Number

 

The IP number of the server performing the request.

 

Date/time

 

The time of the request

 

Delete

 

Here is an icon you can use to delete the request. If you are a developer and the API has locked you out because you've sent the wrong API key, you can use the delete button to delete the rows that record your activity. If you don't,  you'll have to wait until the lockout has timed out.