diff options
| author | it33 <iantien@gmail.com> | 2015-11-21 09:22:13 -0800 |
|---|---|---|
| committer | it33 <iantien@gmail.com> | 2015-11-21 09:22:13 -0800 |
| commit | a8dc79f06f023b9226ac73c329ca135cea6ea1af (patch) | |
| tree | 69d0294fb229c2549ef366f6207c1f43af64aebc | |
| parent | 24f00ed605d712c6f072d3f6cbff9eaeac2004d4 (diff) | |
| parent | 4688d4d64ebad7307504cd4d6e4d1e878657a8dc (diff) | |
| download | chat-a8dc79f06f023b9226ac73c329ca135cea6ea1af.tar.gz chat-a8dc79f06f023b9226ac73c329ca135cea6ea1af.tar.bz2 chat-a8dc79f06f023b9226ac73c329ca135cea6ea1af.zip | |
Merge pull request #1489 from mattermost/API-integration
Adding notes on building API integration
| -rw-r--r-- | doc/developer/API.md | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/doc/developer/API.md b/doc/developer/API.md index e5e5db2ba..1be3669ab 100644 --- a/doc/developer/API.md +++ b/doc/developer/API.md @@ -33,3 +33,15 @@ Mattermost drivers offer access to the Mattermost web service API in different l ### [Golang Driver](https://github.com/mattermost/platform/blob/master/model/client.go) [client.go](https://github.com/mattermost/platform/blob/master/model/client.go) - This is a RESTful driver connecting with the Golang-based webservice of Mattermost and is used by unit tests. + +## Building API Integration + +If you're building a deep integration with Mattermost, for example a mobile native client, and there is a driver available to support the programming language you are using, it's best to use the driver available to access the [Mattermost Web Service APIs](API-Web-Service.md). + +If no driver is available for the programming language of your choice, you can view the [Golang Driver](https://github.com/mattermost/platform/blob/master/model/client.go) source code to understand how it exercises the Web Service API. You can also learn more by reviewing open source projects that use the Web Service API, like [matterircd](https://github.com/42wim/matterircd). + +There are a wide range of [installation guides](www.mattermost.org/installation/) for setting up your own Mattermost server on which to develop and test your integrations. + + + + |