Welcome to the mtribes developer hub!
This document contains everything you'll need to know about integrating mtribes into your apps. Ready? Let's go.
If you're new to mtribes and haven't modeled your Space, check out our short modeling guide.
First complete these two steps. This initial setup is common across all SDKs.
Next, follow the specific documentation for your platform to complete the integration.
We're working hard on expanding our platform support, so stay tuned for updates.
This is the first step. We've purpose-built a command-line-interface (CLI) to automate most of the process, and help integrate your mtribes Space quickly and accurately.
Install via Homebrew
Upgrade the CLI at anytime via Homebrew
This is the second step. Let's get you connected with the mtribes Space you want to target before diving into the code.
With the CLI installed, you can now set up your Space integration by running the following command in the root folder of your project.
The first time you run
setup, you'll be prompted to enter your secret API key
to authenticate with mtribes. Your secret key is located on your organization's
settings page. You'll need to be an
administrator to access this page.
Once authenticated, follow the remaining prompts to configure your connection.
- Select the mtribes Space to integrate with.
- Choose a target language if the default is incorrect.
- Decide where code should be output if the default location is incorrect.
The CLI will now generate Space specific integration code for you to use.
mtribes.yaml file containing your saved preferences will be written to the root
of your project .
mtribes.yaml and the generated code should be committed to source
Where possible, the CLI will automatically add a dependency to our core SDK library, which the generated code will leverage.
As updates are made to Collection, Experience and Section templates in your mtribes Space, you'll need to synchronize these changes with your codebase so you can integrate them.
You can regenerate code at any point, so that it reflects the latest state of your Space
via the CLI's