Has anyone had much success using the API?
I was playing around with it several months ago and it was going well but then suddenly the channels API was returning 0 channels.
Users API only returns the same 4 users.
Device API works fine and returns as many devices as I ask for.
I checked again today and it is still the same behaviour.
Solved
Any success with the API?
Best answer by Oldman Winter
Just an update after I figured out the problem.
Another POC changed the permissions with the account associated with the API key.
So make sure you have given the account access to all channels that you need to read and of course, any other permissions or roles depending on what info you are pulling.
Other than that you don’t need any parameters to start pulling the channel info from the directory.
Just note that unless you add the limit parameter you will only get 20 channels by default.
Appspace API Documentation
Assuming you’re making a call to /api/v3/channeldirectory to simply list all channels:
This API call in particular needs some data up-front. At a minimum it requires the parameters networkID & pageCount
In Postman this can be parameterized as such:
You can more easily fetch the networkID you want to search by going into the console and going to Locations, click on the network in question, then review your browser URL header.
This makes no sense.
None of those are listed as required parameters.
Pagecount isn’t a parameter at all.
Creating a request in postman with the same settings still gives 0 results.
It used to work just fine and then one day it stopped working.
It literally returns this.
{
"items": [],
"start": 0,
"limit": 0,
"size": 0
}
It also used to give strange results with missing data for certain channels, but I was usually able to clear that up by deleting and recreating it.
If the permission list was blank removing groups and re-adding them solved that.
It’s worth putting in a ticket so we can review this over a secure thread but then next thing I’d want to see is your request URL & structure. Something is likely missing.
Just an update after I figured out the problem.
Another POC changed the permissions with the account associated with the API key.
So make sure you have given the account access to all channels that you need to read and of course, any other permissions or roles depending on what info you are pulling.
Other than that you don’t need any parameters to start pulling the channel info from the directory.
Just note that unless you add the limit parameter you will only get 20 channels by default.
Appspace API Documentation
Sign up
Already have an account? Login
Choose an option below to login:
Partners: If you do not have an Appspace login, please contact community@appspace.com for assistance.
Appspace Employees Customers and PartnersLogin to the community
Choose an option below to login:
Partners: If you do not have an Appspace login, please contact community@appspace.com for assistance.
Appspace Employees Customers and PartnersEnter your E-mail address. We'll send you an e-mail with instructions to reset your password.