The BotDetect Developer API enables developers to seamlessly integrate bot detection functionalities into their existing platforms or applications. The API provides a wide range of functionalities such as campaign links management, manage IP Address, manage tags.
\nThe BotDetect Developer API is built to be user-friendly and easy to understand, through the implementation of REST principles. The API follows RESTful conventions as much as possible and uses common methods like GET, POST, PUT, and DELETE for operations. The request and response bodies are encoded in JSON. Additionally, the API adheres to standard HTTP response codes and requires authentication for all requests to ensure secure and reliable integration.
\nThe base URL for all API requests is api.botdetect.ai/api.php/, and all requests must be made over HTTPS.
You can sign-up for the API subscription at our website -
\nhttps://botdetect.ai/registration/
\nAfter Signing up you'd need to subscribe to one of packages. Check out the packages on the following link.
\n\nOnce you buy a API package from the website, you will get api_key from your \"My Account\" page. You must pass api_key in the authorization header as bearer token.
Retrieves the information of an existing link.
\n","urlObject":{"path":["api.php","link","24"],"host":["https://api.botdetect.ai"],"query":[],"variable":[]}},"response":[],"_postman_id":"516ad09b-377e-41c2-9f80-760ebb7f9f85"},{"name":"create link","id":"74472550-8a2b-481b-8c1d-b9e8fdbc6366","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Bearer IK2h9TfgWtapliAEyJ3nyOAPU9aPEn"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Name\":\"burr ist\",\"TargetURL\":\"https://burrist.co.uk\",\"Description\":\"A link description\"\r\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost/botdetect/api.php/link","description":"Creates a new link entity. Parameters should be passed as a JSON object within the raw request body.
\nWhen creating a link the TargetURL and Name should be provided, Description UTMSource, UTMMedium and UTMCampaign optional, if UTMSource is populated though then so should UTMMedium and UTMCampaign be. A list of TagIDs can also be supplied as an array named Tags. The response will provide the trackable URL. Example below.
\n{\n \"Name\":\"Burr IST\",\"TargetURL\":\"https://burrist.co.uk\",\"Description\":\"A link description\",\"UTMSource\":\"asd\",\"UTMMedium\":\"df\",\"UTMCampaign\":\"dfg\",\"Tags\":[1,2]\n}\n\nUpdates a specific link entity. Only the contact fields that are included in the body will be updated.
Parameters should be passed as a JSON object within the raw request body. Can be used to modify the Name, TargetURL, Description, Status, UTMSource, UTMMedium and/or UTMCampaign.
Deletes an existing link.
\n","urlObject":{"path":["api.php","link","17"],"host":["https://api.botdetect.ai"],"query":[],"variable":[]}},"response":[],"_postman_id":"4783b529-de37-4a69-9ac4-e733ce246cab"},{"name":"get links","id":"1f01ccef-b8a6-405c-bbf5-3c8ad385445d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Bearer IK2h9TfgWtapliAEyJ3nyOAPU9aPEn"}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.botdetect.ai/api.php/link/?page=1&Name=Test Name&Description=Test Description&UTMCampaign=MyCampaign&UTMSource=MySource&UTMMedium=MyMedium&Status=LIVE","description":"Returns all link entities - 500 per request. To get the next page use e.g. /api.php/link/?page=2
\nYou can use filters in the request body to limit the results to only records with matching link field values.
\nStatus attribute is used to filter on condition
Valid values for the Status parameter are LIVE, PAUSED, ARCHIVED, DELETED
You can manage your link using the API endpoints.
\n","_postman_id":"91f8ff47-51e0-4e65-b6b0-aae6915d7f81"},{"name":"IP Address","item":[{"name":"get ipaddresses","id":"81cb6676-12eb-4676-8e0b-e788464d70e1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Bearer IK2h9TfgWtapliAEyJ3nyOAPU9aPEn"}]},"isInherited":false},"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"https://api.botdetect.ai/api.php/ipaddress/?IPAddress=123.123.123.123&page=1","description":"Returns all ipaddress entities - 500 per request, to get the next page use e.g. /api.php/ipaddress/?page=2
\nTo search for a specific IP Address use the query string parameter IPAddress e.g. /api.php/ipaddress/?IPAddress=123.123.123.123. If a record for the ip address cannot be found it will query 3rd parties to get info about this ip address and store and return the resulting record.
\n","urlObject":{"path":["api.php","ipaddress",""],"host":["https://api.botdetect.ai"],"query":[{"key":"IPAddress","value":"123.123.123.123"},{"key":"page","value":"1"}],"variable":[]}},"response":[],"_postman_id":"81cb6676-12eb-4676-8e0b-e788464d70e1"}],"id":"bd58a471-c8ae-40d8-ae87-519afd3d5d5a","_postman_id":"bd58a471-c8ae-40d8-ae87-519afd3d5d5a","description":""},{"name":"Engagement","item":[{"name":"get engagement","id":"f39ae0f9-8c9b-4483-91a9-10ee28921851","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Bearer IK2h9TfgWtapliAEyJ3nyOAPU9aPEn"}]},"isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":""},"url":"https://api.botdetect.ai/api.php/engagement/23","description":"Returns a specific engagement entity.
\n","urlObject":{"path":["api.php","engagement","23"],"host":["https://api.botdetect.ai"],"query":[],"variable":[]}},"response":[],"_postman_id":"f39ae0f9-8c9b-4483-91a9-10ee28921851"},{"name":"get engagements","id":"28fa1f24-0cfc-43cf-a79d-7536fa63428d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Bearer IK2h9TfgWtapliAEyJ3nyOAPU9aPEn"}]},"isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":""},"url":"https://api.botdetect.ai/api.php/engagement/?LinkID=12&DateAfter=2020-12-12&DateBefore=2023-12-12&IsRobot=0","description":"An engagement entity represents when a link's trackable url has been accessed.
\nCan be filter using the query string parameters LinkID, DateAfter, DateBefore and IsRobot
\nIsRobot attribute parameter are 0, 1