API specification
Cross posted from GitHub issues: https://github.com/mattermost/platform/issues/69
I see that the code appears to be logically organised around a clean-looking API; I can go and read through the Go source and get to understand it, but it'd be better if there were a specification of that API clearly written somewhere for reference. As this is a developing project, it'd especially be useful to know what parts of the API are considered "stable".
Lets-Chat have an API spec which was invaluable to me in writing a Python API wrapper and I'd love to do the same for Mattermost. :)
Adminmattermost.org
(Moderator, Mattermost)
shared this idea
-
Hi Walter, and anyone watching for this feature,
Contributions highly welcome for anyone who wants to add to the Web Service API documentation: https://github.com/mattermost/docs/blob/master/source/developer/web-service.md
It's definitely used by Community Applications: http://www.mattermost.org/community-applications/
If each developer were to add one or two methods, it would be a huge benefit to the community. If it's your first PR on a Mattermost project, we've got a custom-designed Mug for you: https://forum.mattermost.org/t/limited-edition-mattermost-mugs/143
Right now the best way to understand the Web Service is to examine the Golang driver, or possibly the Javascript driver.
-
Walter Heck
commented
Is there any word on API documentation yet? We'd love to be able to create channels and users programmatically for a product we're building mattermost into. Right now it's a bit of a search to find out what parameters are needed and which endpoints to talk to.
-
Thanks Michael, here's a start to the documentation: https://github.com/mattermost/platform/blob/master/doc/developer/API.md
Incoming webhooks in Mattermost v1.1 (available since 10/16) are largely Slack compatible and you can view examples here: http://www.mattermost.org/community-applications/
Outgoing webhooks are on master, some apps from the link above use them already, and they'll be out in Mattermost v1.2 on 11/16
Mattermost now ships monthly on the 16th.
-
Michael Stewart
commented
Super looking forward to some documentation and a way to get an API key.
-
Andrew McClenaghan
commented
It would be great if there was a Slack compatible API as well. So we could re point anything that is currently pointing at Slack.
-
We're almost there, we demo'd the APIs and examples internally today, just need some time to finish the documentation. Mattermost v1.0 is available to download: http://www.mattermost.org/open-source-slack-alternative-reaches-1-0/
Mattermost v1.1 is planned for Oct 16, and from then on we plan to ship on the 16th of the month regularly.
-
Andrew Tkachenko commented
Same here expecting API and some examples how to use it.Until we use only as public chat
-
Brian Jackson commented
What's the timeline for 1.0? The power of Slack is integrations, without a way to integrate Mattermost into our ecosystem (Jenkins, issue tracking, etc) I'm not compelled to adopt it yet.