This is a quick guide to help you get started using our API.

1. Create an API key

Go to Team settings in the user menu, then click on the API keys card. Please note that you need admin permissions for the team to be able to see this card.


2.  Generate API key

Generate a new API key by clicking the Generate API key button. API v2 enables you to add multiple API keys if you wish to do so. This list will also include old keys generated for API v1.


3. Test your credentials

Verify that you have extracted the right information by testing the API with a tool like Curl. Enter the following as the URL:

https://<api key>@api.detectify.com/rest/v2/domains/

You should get a JSON response including information for the domains you have in your team.

4. To see more detailed API key settings click on a particular API key

Pull the toggle and click on "save" button if you want to enable a particular API setting.

Here you can also choose to revoke the API key.



5. Message signature

For additional security, you can also sign the message based on the secret key specified for your API key.


 

6. Implementing the API

For further information on how to implement the API and code examples, please visit our developer portal at https://developer.detectify.com. Happy scanning!