Getting started
Last updated
Last updated
Welcome to the official documentation for the REST API of dScribe, the Software as a Service (SaaS) platform for data cataloging and management. Our API provides developers with comprehensive tools to integrate dScribe's robust data catalog capabilities into their applications, enabling efficient and secure access to a wide array of data assets.
dScribe's REST API is designed to offer a seamless experience for managing and interacting with data assets and dataset elements (dses) within our platform. Whether you are looking to automate data cataloging, enhance data discovery, or streamline data governance, our API empowers you to do more with your data.
CRUD Operations: Our API supports full Create, Read, Update, and Delete (CRUD) operations, allowing for complete management of data assets and datasets within the dScribe ecosystem.
Secure Access: We prioritize security with authenticated access, ensuring that your data remains protected while providing flexibility for integration.
Before diving into the API, ensure you have the following prerequisites:
dScribe Account: A registered dScribe account is required to access the API.
API Key: Obtain an API key through your dScribe account for authentication.
Familiarity with RESTful Principles: Basic knowledge of RESTful conventions and HTTP methods (GET, POST, PUT, DELETE) is recommended.
To get started with the dScribe API, you'll need an API key, which you can obtain by signing up for an account on our website. Than, navigate to the Api Keys tab on the admin page.
After you created a key, you will see your client_id and client_secret. This will only be shown once, store it somewhere safe.
The client_id and client_secret can now be exchanged for an access_token to make authenticated requests. This token will be valid for 15 days. Add it as a Bearer token to the Authorization header.
Authorization: Bearer yholmghj8§hbfg...
POST /api/api-token
To get a JWT token you can send a POST request to https://company.dscribedata.com/api/api-token.
Body
| Name | Type |
|---|---|
| string |
| number |
| client_credentials |
| default |
Response
Should you encounter any issues or have suggestions for improving our API, please reach out to our support team. We value your feedback and are committed to enhancing the dScribe API experience.
