Getting started with the APIs

You can integrate with Atlan in several ways. We recommend using one of our software development kits (SDKs), if possible, which:

  • encode best practices,
  • are built for performance,
  • and add validations and simplifications not found in the raw REST APIs themselves.
πŸ’ͺ Did you know? Our SDKs are nothing more than client libraries that wrap our underlying REST APIs. They prevent you from needing to reinvent the wheel by wrapping the REST APIs yourself.

For initial experimentation with our APIs, you can also explore using Postman.

Import Postman collection

To import the Postman collection:

  1. In your Postman workspace, click the Import button.
  2. In the Import window, click the Link tab.
  3. Under Enter a URL, paste this link β€” https://atlanhq.github.io/openapi/atlan_collection.json β€” and then click the Continue button.
  4. From the Import summary, click the Import button.

After a few minutes the core APIs will be available in your workspace in a collection named Atlan API. πŸŽ‰

πŸ§ͺ Preview feature! This collection is for experimentation purposes only. For documented examples and reference material, see https://developer.atlan.com.

Define Postman environment

Before you can use the APIs in Postman, you will need to:

  1. Configure a Postman environment with the following variables:
    • baseUrl β€” the full URL for your environment, including the https:// (for example, https://tenant.atlan.com).
    • authToken β€” the bearer token you copied from Atlan when configuring an API token.
  2. Set the authToken variable as the bearer token on the collection itself.

You will are ready to use Postman to call the APIs! πŸŽ‰

Related articles

Was this article helpful?
1 out of 1 found this helpful