Send a Test Request¶

Your Base URL¶

Before we continue lets make sure we've got the correct URL and can access the API.

You should have a unique API URL after you installed the Wyzed API integration. It looks like this:

https://TENANT_ID.REGION.api.wyzed.com/api/v1

Tip

You can view this URL at any time by visiting Account Settings > Integrations > Installed Integrations and clicking on the API Integration you installed earlier. If you haven't installed the integration yet click here for instructions.

Send a Test Request¶

We have a test endpoint available at /test. It's not authenticated so you can simply paste it into your browser or use cURL via the command line to test that you have the correct URL.

Test in Browser¶

Paste your API URL followed by /test into a browser:

https://TENANT_ID.REGION.api.wyzed.com/api/v1/test

Test with cURL¶

Replace the URL below and run the following from your command line or terminal:

curl -X GET https://TENANT_ID.REGION.api.wyzed.com/api/v1/test \
     -H 'Accept: application/json'

Response¶

Both those options will return a response like so:

{
    "tid": "TENANT_ID"
}

tid will always equal your TENANT_ID part of your URL.

Next Steps¶

If that worked, you're good to move onto Authentication and start putting the API to use!