Spider Impact has an API for other software to read information about organizations and scorecards.

API Tokens

Everything that uses the Spider Impact API needs an API token. To manage these API tokens, go to the API Tokens screen in administration.

When you click “Create API Token” it shows this dialog where you give your new API token a name. It’s a good idea to call it something related to the computer or software that will be using it.

You now have a new API token, and anyone who uses it will interact with Spider Impact as the user you’re logged in as right now. Copy the API token by clicking on the Copy link on the right.

Interactive API Documentation

In the blue instructions in the last screenshot, you’ll see an “interactive API documentation” link. When you click this, you’ll be taken to the full API documentation that is part of your installation of Spider Impact. This is accessible at a URL like:
https://yourserver.com/resources/api-docs/api-docs.html

This documentation page explains how to communicate with Spider Impact’s API. It also allows you to test the API by interacting with your real data. To start, click the green Authenticate button.

Then paste in your API Token and click Authorize.

Finally click Close.

Now, when you’re viewing the API documentation you’ll be able to click the “Try it out” buttons.

These allow you to directly interact with your real data. In this example we’ve chosen to view information about a specific scorecard, and then clicked the Execute button. The interactive documentation not only shows you the results from the server, but it also shows you the exact request you need to make to the Spider Impact API to get that same data.