API REST v1

L'API REST Road To v1 vous permet de créer des templates et des projets depuis n'importe quelle application externe.

Authentification

Toutes les requêtes doivent être authentifiées avec une clé API.

Deux méthodes sont supportées :

Header Authorization (recommandé) :

Authorization: Bearer rt_org_votreclé...

Header X-Api-Key :

X-Api-Key: rt_org_votreclé...

Pour obtenir une clé API :

• Clé personnelle : Compte → Clés API
• Clé d'organisation : Organisation → Paramètres → Clés API

Endpoints

POST /api/v1/templates

Crée un nouveau template dans votre organisation.

Requête :

POST /api/v1/templates
Authorization: Bearer rt_org_...
Content-Type: application/json

Corps de la requête :

{
  "template": {
    "version": 1.0,
    "versionTemplate": 1,
    "id": "TEMPLATE01",
    "locale": "fr",
    "name": "Mon template",
    "description": "Description du template",
    "sections": [
      {
        "id": "SECTION001",
        "version": 1,
        "title": "Section 1",
        "description": "Description de la section",
        "tasks": [
          {
            "id": "TASK00001",
            "version": 1,
            "text": "Tâche 1"
          }
        ]
      }
    ]
  },
  "notify": ["user@example.com"]
}

Réponse (201 Created) :

{
  "id": "abc123",
  "name": "Mon template",
  "description": "Description du template",
  "createdAt": "2026-03-18T08:00:00.000Z"
}

---

POST /api/v1/projects

Crée un nouveau projet dans votre organisation.

Requête :

POST /api/v1/projects
Authorization: Bearer rt_org_...
Content-Type: application/json

Corps de la requête :

{
  "name": "Mon projet",
  "description": "Description optionnelle",
  "templateId": "abc123",
  "notify": ["collaborateur@example.com"]
}

Ou avec un template inline :

{
  "name": "Mon projet",
  "template": {
    "version": 1.0,
    "versionTemplate": 1,
    "id": "TEMPLATE01",
    "locale": "fr",
    "name": "Template inline",
    "description": "...",
    "sections": []
  }
}

Réponse (201 Created) :

{
  "id": "xyz789",
  "slug": "mon-projet-a1b2",
  "name": "Mon projet",
  "projectUrl": "https://roadto.app/orgs/mon-org/project/xyz789"
}

---

Codes d'erreur

Code	Description
401	Clé API manquante, invalide ou expirée
400	Corps de la requête invalide (erreur de validation)
500	Erreur serveur interne

Note sur le rate limiting

L'API n'applique pas de rate limiting actuellement. Un usage abusif peut entraîner la révocation de votre clé API.