WANT TO GROW YOUR ORGANIC SEARCH CHANNEL? SCHEDULE YOUR DEMO NOW.

The Render URL API endpoint gives your team the ability to add a URL to Huckabuy’s Index along with rendering and caching the optimized page. If the URL is already part of Huckabuy’s Index, the URL will just be re-rendered and cached.

Example Use-cases

If you’ve recently deployed a new page or an update to an existing page of your website and would like Huckabuy to index & render this URL, this endpoint will do so. An example would be incorporating this into your website’s build and deploy process so anytime you deploy a new or updated page, Huckabuy can immediately render it.

API Details

Endpoint URL:

https://api.huckabuy.com/d/render/{URL}

HTTP Method:

GET

Required Headers:

Name /typeDescription /example
X-Auth-Token
string		Your Team’s API TokenDwZ05Ex2N8W34YqWkiKWgayk

Required Parameters:

Name /typeDescription /example
url
string		URL to Renderhttps://example.com/about-team

cURL (example)

curl "https://api.huckabuy.com/d/render/https://example.com/about-team" \     -H "X-Auth-Token: DwZ05Ex2N8W34YqWkiKWgayk"

Response (example)

{
"success": true,
"message": "Successfully added https://example.com/about-team for rendering"
}
Frequently Asked Questions

  • The Render URL API endpoint is a feature provided by Huckabuy that allows your team to add a URL to Huckabuy’s Index. It also provides the functionality of rendering and caching the optimized page.

  • If the URL is already part of Huckabuy’s Index, the URL will just be re-rendered and cached. This ensures that the most recent version of the page is always available in the index.

  • You would use the Render URL API endpoint when you've recently deployed a new page or an update to an existing page of your website and you want Huckabuy to index and render this URL. This can be incorporated into your website’s build and deploy process.

  • The endpoint URL for the Render URL API is https://api.huckabuy.com/d/render/{URL}. This is where you send your GET request to add or update a URL in the Huckabuy index.

  • The HTTP method used with the Render URL API endpoint is GET. This is used to retrieve the specified URL and add it to the Huckabuy index.

  • The required header for the Render URL API endpoint is X-Auth-Token. This should be your team’s API Token.

  • The required parameter for the Render URL API endpoint is the URL that you want to render. This should be provided as a string.

  • You can use cURL with the Render URL API endpoint by sending a GET request to the endpoint URL with the required headers and parameters. An example command is provided in the knowledge base article.

  • The response from the Render URL API endpoint will be a JSON object indicating whether the operation was successful and a message. If successful, the message will confirm that the URL has been added for rendering.

  • The X-Auth-Token header is used to authenticate your team's requests to the Render URL API endpoint. It should contain your team’s API Token.