Kickserv APIv2 - FAQ

who are you? what do you do at kickserv?

I do not work for Kickserv. I'm just a guy who decided to write some documentation.

why can't i _______ using the api? when will i be able to _______?

Please see previous question.

i copied and pasted something from your docs and i got an error!

The documentation is general and not intended to be copy/paste. It describes the endpoints only and is not a step-by-step tutorial. It's up to you to translate the HTTP requests into whatever syntax your development environment/language requires.

is there a way to _______?

If we know how to do it, it's probably listed here. Well, that's mostly true. A lot of endpoints can accept pagination parameters but we didn't list that on every single endpoint, for example.

what about apiv1? how about apiv3?

We haven't posted any documentation for APIv3 at this time; it takes a lot of work to piece everything together. If you find this documentation helpful let us know so that we can tell if it's worth writing APIv3 documentation. Kickserv has documented APIv1 here.

what programming/scripting languages can i use if i want to write something that uses the api?

Whatever you can make work. Anything with basic HTTP functionality will probably suffice. Javascript/Node, PHP, Python, Erlang, the one language that your friend won't shut up about, just about anything will work.

what's a good starter project for me?

Whatever you feel like you need or would make your life easier. If there's something that you do over and over and need to speed up or handle with one click, that's a good option.

i found a bug in the api, who do i tell?

If you feel like telling us we'd like to know, but all we can do is tell Kickserv. We do not maintain the Kickserv code base. Officially, the API is unsupported but we're sure they'd like to hear about it. Email them at support@kickserv.com.

my code doesn't work!

The API is unsupported. It's up to you to make your code work. Depending on the exact situation we may be contracted to provide best-effort third-party assistance for a fee. Contact Us if you would like to get a quote. If you just have a simple question we might be able to give you a simple answer. Keep in mind that we do not know every programming language or development environment.

i found something wrong in your documentation!

Cool. Please email kickservapi@veildg.com with as much detail as is needed including the page with the error. Something like "found typo. not work..!" doesn't really help as much as you might think it does. We try to keep things up to date, but if Kickserv makes a change we're not notified any more than you are. If you spot something that's different we'd appreciate it if you let us know.

i found a new endpoint/parameter!

Neat. Please email kickservapi@veildg.com with as much information as you have and if it's something that can be added, we'll do so. Please keep in mind that an endpoint must be functional/useful. There are a number of 'internal' endpoints that are in use by the web UI/mobile apps that require a key or nonce of some sort. Since we don't have the key and don't know how to generate them those endpoints aren't particularly helpful. Please make sure the endpoint you're reporting a) works outside of a web browser and b) is not already listed.

are you from west virginia?

No, and I'm not even sure why I included this question. No one has ever asked me that.