|
Admin API Socket Permissions
|
|
Welcome to the Adilas API Socket Permissions page. This page allows you to open up API access for all or specific users. Below is listed the current accessible API method calls. By checking or un-checking a method you are opening or closing access to that part of your API. It is smart to limit access to just methods you need.
An API (Application Programming Interface) is a set of rules and protocols that allows different software applications to communicate with each other. Basically, it allows computers and servers to talk to each other. This page has a number of settings. The top two settings are designated based on which server and corporation id number you are using or assigned to. They are important if you end up using the API sockets. They are the server name (web address) and corp key. API Username - You get to set the username that will be used for all API socket calls. We recommend that you make it fairly strong. API Password - You also get to set the API socket password. This password is just for using the API sockets and could and should be different than your user password. User Id's Allowed - Use the builder link to fill in this field. These are user/payee id's that may access the API. As a note, at least one id is required. This user id will used to record any history notes for any database activity that is done. You are allowed to use a comma delimited list if needed. When the actual API call is made, only one id may be used at a time. The bottom section on this page shows all of the exposed API Socket function s or method names. Use the checkboxes to virtually open/close these methods. Unclicked means closed. Clicked means allow or use. We highly recommend that you only open up what you need to. Think of these methods or functions like windows or doors on a house. If you want to keep things tight, keep them all closed unless you need them. If you open up everything, it like having a house with hundreds of windows and doors, all open to the public (bad idea). Feel free to open/close these settings at any time. This page requires an admin level user to open/close these API socket permissions. Also, whenever used, we do record a history message of what was called and who made the call. These logs may be requested, if needed. Please use caution. API's are awesome but please be careful in their usage and settings! For more help on using the actual API sockets - click here. |