API
A crawler automatically updates the list of websites. Only registered partners at GetKirby.com can apply to me for an API key to submit new websites and manage their listed websites.
Read time 1 minute
Using the API for Partners
If you are a registered partner at GetKirby.com, you can contact me via Discord or e-mail, and I will provide you with an API key.
Known Limitation: You can not link websites on this index to your user account. Please send me a newline-separated list of your URLs, and I will re-link your user account to them.
Caches are flushed every full hour, so it might take a while for your pages to appear as listed/updated/deleted.
The examples use CURL, but you can use any tool to send the queries.
List all your websites
curl --request GET "https://audit.bnomei.com/reports?expand=1" --header "X-API-KEY: {your_api_key}"Add a new website, link it to you, check for Kirby and fetch metadata
curl --request POST "https://audit.bnomei.com/reports?url=https://example.com" --header "X-API-KEY: {your_api_key}"List details about one of your websites
curl --request GET "https://audit.bnomei.com/reports/{id_of_website}?expand=1" --header "X-API-KEY: {your_api_key}"Trigger the meta-data refresh for one of your websites
curl --request PATCH "https://audit.bnomei.com/reports/{id_of_website}" --header "X-API-KEY: {your_api_key}"Upload a custom preview screenshot for a website (JPG, <200kb)
curl -F "preview=@path/to/preview.jpg" https://audit.bnomei.com/reports/{id_of_website} --header "X-API-KEY: {your_api_key}"Delete a website
curl --request DELETE https://audit.bnomei.com/reports/{id_of_website} --header "X-API-KEY: {your_api_key}"