Aller au contenu
UnisoftDocumentation développeur

REST API / v1

Connectez vos outils à Unisoft.

Un premier appel, les règles essentielles, puis chaque opération documentée avec ses paramètres et ses exemples.

Environnement de cette documentation · Productionhttps://api.unisoft.world/integrations/v1

Votre premier appel

Commencez par une lecture pour vérifier votre connexion avant toute écriture.

1. Préparer votre clé

Dans le backoffice Unisoft, ouvrez Développeurs, créez une clé API et accordez uniquement les permissions nécessaires à votre intégration. Copiez la clé lors de sa création.

2. Choisir le bon environnement

La production et le développement ont des domaines distincts. Utilisez une clé créée dans l’environnement appelé.

PRODUCTION=https://api.unisoft.world/integrations/v1
DEVELOPMENT=https://kehilaapi.syn-assist.fr/integrations/v1

3. Vérifier la connexion

export UNISOFT_API_URL='https://api.unisoft.world/integrations/v1'
export UNISOFT_API_KEY='ke_live_REPLACE_WITH_YOUR_KEY'

curl --fail-with-body "$UNISOFT_API_URL/me" \
  --header "Authorization: Bearer $UNISOFT_API_KEY"

GET /me retourne l’organisation, les permissions de la clé et les langues activées. Vérifiez ces informations avant de continuer.

Exemple

{
  "success": true,
  "data": {
    "apiKey": {
      "id": "key_example",
      "name": "Example integration",
      "prefix": "ke_live_",
      "scopes": [
        "contacts:read"
      ]
    },
    "organisation": {
      "id": "org_example",
      "name": "Example organisation",
      "shortName": "Example",
      "defaultLanguage": "fr",
      "enabledLanguages": [
        "fr",
        "en"
      ]
    }
  }
}

4. Lire vos premiers contacts

Cet appel nécessite la permission contacts:read. Les paramètres de recherche disponibles figurent dans la référence API.

curl --fail-with-body "$UNISOFT_API_URL/contacts?limit=10" \
  --header "Authorization: Bearer $UNISOFT_API_KEY"

La référence détaillée est disponible en français et en anglais. Les noms des routes, des champs et des valeurs techniques restent inchangés.