Skip to content

API

The REST API can be a powerful tool to help you manage your equipment and users. By integrating this API into your system(such as billing system), you can improve additional functionally for your system. Additionally, you can also use this API to query your equipment for information, manage devices.

Authentication

Supporting methods for access:

  1. Using auth token
  2. Using trusted networks

Use auth token

1. Create some user(with login api_user for example)
2. Over console utility generate auth token, over command

wca user:generate-key api_user 365d
where arguments api_user - user login and 365d - key expiration.
The answer should be a table, with one field containing the key.
3. Now, You can work with API, adding header X-Auth-Key: API_KEY_FROM_TABLE

Over web panel, go to Configuration->System configuration->Configuration[Tab].
In block security, set field trusted network list, in CIDR (10.0.0.0/8 for example).

Requests without a key but on a trusted network will show up from the builtin sys user

Documentation

API methods, example of responses are documented in postman wildcoreAPI (The documentation may not contain all the information of you need)

Also, since the web panel is built on the SPA framework, you can view the called API methods (via F12) and use them

Development

For PHP developers added SDK (testing) - github.com/meklis/wildcore-api-client, examples