The guides are designed to help you get familiarized with the necessities of the Tidal API, giving you a quick and clean approach on getting started. They will help you in understanding the fundamental components the API offers and how to use them.
What the guides cover
These guides cover common tasks that we find users use the API to complete. If there is something you are looking to do with the API and you are having trouble send us a message at firstname.lastname@example.org and we’ll help you.
You will need to have access to a software that will allow you to make HTTP requests to the API. There are many different tools to choose from. The main functionality you will need is the ability to change the HTTP request method type (
PUT, etc), and specifying Headers for the request.
Two tools that we would recommend are either cURL or Postman.
- cURL is a CLI utility that is preinstalled on most Linux and macOS OSs, and is also available for Windows. cURL is fully CLI driven, if you are comfortable on the command line then this is a good option.
- Postman is a GUI based application that can run on most major OSs. If APIs are new to you and you aren’t comfortable on the command line, this is a better option than cURL.
Your First (and second) API Request
The first request you should make is the
/pingrequest. Checkout the Authentication guide to try the ping request.
Once you can ping the API. Give the
/authenticaterequest a try and authenticate with the API.
Full API Documentation
You can access all of the API documents via https://[your_subdomain].tidalmg.com/docs/ Replace start of the address above with your Tidal Migrations subdomain. For additional help on getting your subdomain, refer to Get Subdomain & type in your email in the prompt bar. Afterwards, you will receive an email with all of your workspaces.