BigID API/Best Practices: Difference between revisions
| Line 4: | Line 4: | ||
== Start with the data you need == | == Start with the data you need == | ||
When developing an integration, first write down what data you need. There's a lot of data inside of our API and it's easiest to search for something when you know what you're looking for. Once you have your list of what you need for your integration, search the [https://docs.bigid.com | When developing an integration, first write down what data you need. There's a lot of data inside of our API and it's easiest to search for something when you know what you're looking for. Once you have your list of what you need for your integration, search the [https://docs.bigid.com BigID Docs] for an API that provides that data. | ||
== Every API has a reference example - The UI == | == Every API has a reference example - The UI == | ||
The API powers our UI as well as your integrations. That means anything you can see within the UI is accessible to you programmatically. If you're struggling to find a piece of information in the API documentation, find it in the user interface. The network activity of that page will give you the API endpoint you're looking for. See how to examine network activity [https://developer.chrome.com/docs/devtools/network/|here]. | The API powers our UI as well as your integrations. That means anything you can see within the UI is accessible to you programmatically. If you're struggling to find a piece of information in the API documentation, find it in the user interface. The network activity of that page will give you the API endpoint you're looking for. See how to examine network activity [https://developer.chrome.com/docs/devtools/network/|here]. | ||
Revision as of 03:17, 8 March 2022
Before you start developing, there's some things you should keep in mind.
Start with the data you need
When developing an integration, first write down what data you need. There's a lot of data inside of our API and it's easiest to search for something when you know what you're looking for. Once you have your list of what you need for your integration, search the BigID Docs for an API that provides that data.
Every API has a reference example - The UI
The API powers our UI as well as your integrations. That means anything you can see within the UI is accessible to you programmatically. If you're struggling to find a piece of information in the API documentation, find it in the user interface. The network activity of that page will give you the API endpoint you're looking for. See how to examine network activity [1].