Cozy Konnector Libs
This package contains all the shared libs which can help the creation of a connector and also the cli tools to run a connector outside a cozy.
-
View the interactive tutorial.
-
Check out SFR mobile connector for a real life konnector
-
Read the docs
If you want to work on Cozy Konnector Libs and submit code modifications, feel free to open pull-requests! See the contributing guide for more information about how to properly open pull-requests.
The lib contains a way to wrap common errors. Those messages and methods are located under the errors namespace.
If your konnector needs a 2FA token, we recommend that you call the errors.requireTwoFactor method in your code. This way, the stack and the Cozy-Collect app will be notified that the user needs to supply its token.
The requireTwoFactor method allow you to pass a JS Object as argument. This object will be serialized when the 2FA notification will be passed to the Cozy-Collect app. When your user will supply its token, this object will be deserialized and passed as regular fields to your konnector. You'll so be able to continue the auth process. Common fields that can be passed are SESSIONID and _csrf tokens.
Cozy is a platform that brings all your web services in the same private space. With it, your webapps and your devices can share data easily, providing you with a new experience. You can install Cozy on your own hardware where no one's tracking you.
The lead maintainer for Cozy Konnector Libs is doubleface, send him a 🍻 to say hello!
You can reach the Cozy Community by:
- Chatting with us on IRC #cozycloud on Freenode
- Posting on our Forum
- Posting issues on the Github repos
- Say Hi! on Twitter
Cozy Konnector Libs is developed by Cozy Cloud and distributed under the MIT license.