It doesn’t work! Troubleshooting the apaleo API
Sometimes things don’t work as you expect them to – here are some tips & tricks on how to figure out what’s wrong, and what to do then:
First thing to check is the status code you get in the response:
401 – Unauthorized.When you are using the client credentials flow, this means there is something wrong with your token, or the way you pass it. Check the Getting Started Guide for how to do it. When you are using the apaleo or Swagger UI, all should be good if you log in. On Swagger, use the “Authorize” button in the top-right corner.
403 – Forbidden. Your client or user does not have the rights to access a specific resource. Contact us to request more access.
404 – Not Found. You can get this, when you try getting, updating or deleting a resource. That can either be a typo in the URL, or a wrong id you are passing as a query parameter.
405 – Method not allowed. You will get this, if you use the wrong HTTP verb, for example POST instead of PUT. Check the API definition to see which verbs to use for which action.
424 – Something’s wrong. The apaleo API uses this as a catch-all for client side errors, and we try our best to provide more information in the error response message. In simple cases, the request you passed in is not valid: mandatory fields are not set, or in a wrong format we don’t understand. But it can also be that some setup is missing, for example when you are trying to add a unit to a group that does not exist. If you do not have access to the resources to fix the root cause, please reach out to the customer for which this problem appears, because we can’t fix it, either. We would rather not want to mess with our clients data.
500 – Oh no! This should never happen, as it means there is something broken on our side. We monitor those errors, and will see it as soon as you do – and then start investigating and fixing. If you want to be notified when it’s fixed, or want to help us by providing additional information on what you did, https://github.com/apaleo/api is the best way to get in touch.
Check https://status.apaleo.com/ to see if apaleo is up and running – and if it’s not, check back in a few minutes. There’s no need to tell us, as our army of friendly robots already did that.
❤ Your apaleo team