Before you use the Web API tile with an API you may need to add that API as a provider in SquaredUp. Adding an API provider is a one-time configuration task to be carried out by a SquaredUp administrator. Once a provider has been configured for a particular API provider, for example Pingdom, it can be used in multiple tiles.
A new provider can be added from the right-hand menu ☰ > system > Integrations > Add An Integration
This is described below: Adding a new provider
The Web API tile can utilise any API which returns JSON. In particular, REST (Representational State Transfer) APIs, which are a type of stateless web API, are ideal. The tile can connect to services using various authorization methods (more details below).
Your first port of call is the API documentation on the providers website for the service you wish to integrate with. Firstly, you should search for information about the API you want to use (for example, Google rest api docs or oauth2), and then read the API provider's documentation looking for the information you need to use in SquaredUp. Queries are written using the syntax of the remote system you're connecting to, so these will vary between vendors.
If the provider you need has its own button choose that, otherwise use the Web API provider type.
Dedicated provider configuration screens make it easier to add well used API providers:
- Azure Active Directory
- Azure Application Insights (Enterprise edition)
- Azure Log Analytics - How to add an Azure Log Analytics provider
- ServiceNow (Enterprise edition) - How to add a ServiceNow provider
- Elasticsearch - How to add an Elasticsearch provider
- Splunk (Enterprise edition)
Use the Web API provider type for any API which returns JSON, in particular, REST APIs:
- Simple - No authentication, basic authentication (username and password in a header) or Windows authentication (configured automatically to use the application pool identity account).
- Basic Auth - Basic authentication. Your specified username and password will be Base64 encoded automatically.
- OAuth - Token-based authentication according to the OAuth 2.0 standard. Many APIs, including ServiceNow, use OAuth 2.0 for authorisation, and will require an OAuth provider to include the additional information about how to authorise against the service. When adding an OAuth provider you may get an message that the provider is not authorized if some of the provider configuration is incorrect (for example the username, password, secret etc), or if you use a proxy it could be that the proxy is not configured. See How to configure SquaredUp to use a proxy.
Step-by-step instructions to help you add popular providers:
For other APIs, take a look at our Community Answers site, where there's a wealth of knowledge about APIs:
Adding a new provider
- Log on to SquaredUp and navigate to the right-hand menu ☰ > system > Integrations.
- In Add An Integration click on the provider type you need.
If the provider you need has its own button choose that, otherwise use the Web API provider type for any API which returns JSON, in particular, REST APIs.
- If you choose Web API you then need to choose either Simple, Basic Auth or OAuth depending on the API you are using.
- Complete the provider fields, using the web API providers online documentation as a guide.
- You are now ready to use this provider in a tile.
For more information see How to use the Web API tile.