Skip to content

Configure

First, create an account

You have to create your workspace and owner at register page

register

Then, choose and configure your first connector

Connectors need information to works correctly. There are three different ways to configure connectors.

Authenticate by Oauth2

You have to generate a new application on remote service to connect your users through Oauth2.

Then your connector need your application client_id and client_secret.

jira connector exemple

Authenticate by API Key

You have to generate an API Key on remote service and copy paste it on your connector.

Authenticate by User credentials

Some remote service need your user/password to provide there data.

Finally, get your API Key and certificate

api_cert

For your backend : API Key

To fetch your customer data and interact with unified API from your backend your need an API Key.

API Key are linked to your user and workspace. If your user has admin privilege it can read and write data. Users with user privilege can only read data.

To generate an API Key go to your user admin page click on triple dot button of your workspace then choose manage api keys.

This api key will be used as following on your request on munity unified API :

Authorization: X-Api-Key <YOUR-API-KEY>

Exemple with CURL :

curl -X GET 'https://api.munityapps.com/v1/customers/f87cc67d-b594-4407-a90d-b26cfdae8f14/pm-projects/' -H 'Authorization: X-Api-Key REM0aW39.NfO0123456789CNeHpF29wo'

For your frontend : Certificate

You can generate your certificate in Workspace Settings modal. Click on triple dot button of your workspace then you can generate it.

Certificate is used to communicate from your frontend to Unified API. Indeed frontends are not secured so we have to encrypt exchanges.

The only time to communicate with our API from your frontend is when you ask for user credentials.

Our frontend library will make it easier, you only have to provide your connector, secret and a way to wait data, callback or promise.

In next section we will check how to use frontend lib and use it.