Modules and Components

Making Requests

Authorization Required

You need to add the authorization header to make requests

Authorization: Bearer supersecretkeythatisinthevault

Third party API keys are not required

You do not need to provide api keys to the services. This will automatically append

How to make a Request

The request maps to the relevant endpoint via a wildcard;

SEMrush example request

http://0.0.0.0/api/v1/semrush/?type=domain_ranks&export_columns=Ot%2CDb&domain=ayima.com&display_sort=Ot_desc&display_limit=10

maps externally to;

https://api.semrush.com/?type=domain_ranks&export_columns=Ot%2CDb&domain=ayima.com&display_sort=Ot_desc&display_limit=10

Majestic example request

http://0.0.0.0/api/v1/majestic/?cmd=GetIndexItemInfo&item0=www.glassesdirect.co.uk&datasource=fresh&items=1&AddAllTopics=true&EnableResourceUnitFailover=1

maps externally to;

https://api.majestic.com/api/json?cmd=GetIndexItemInfo&item0=www.glassesdirect.co.uk&datasource=fresh&items=1&AddAllTopics=true&EnableResourceUnitFailover=1

Busting Cached Requests

Sometimes you need to bust the cache. In this case simply append bypass_cache=true to the query string.

Busting Cached Requests

Sometimes, you want to only return cached results - you can do this by passing only_cache=true.

If the object is not found it will return a 422 error.

{
  "response": "resource not cached"
}

Checking for cached results

x-cache-hit: 1 or 0
x-cache-tt: time in secs