api-partenaires

Récupérer les routes accessibles

Il est possible de récupérer les informations liées à votre accès (token) en appelant la route GET https://api.myunisoft.fr/api/v1/key/info

Les informations disponibles sont:

• routes accessibles.
• la version du token et s’il peut être mis à jour.
• le statut du token (activé ou non).
• le token décodé

Liste des paramètres (querystring)

Nom	Type	Description	Obligatoire
mode	extended	Récupération des informations du token en plus des routes accessibles.	❌

Récupération des routes accessibles

[!NOTE] Les routes accessibles sont définies en fonction de votre type d’accès (🔹Cabinet ou 🔸Société).

$ curl --location \
--request GET 'https://api.myunisoft.fr/api/v1/key/info' \
--header 'Authorization: Bearer ' \
--header 'X-Third-Party-Secret: ' \

Retour JSON de l’API

```json [ { "path": "/api/v1/society/exercice", "method": "get" }, { "path": "/api/v1/society", "method": "get" }, { "path": "/api/v1/account", "method": "get" }, { "path": "/api/v1/diary", "method": "get" }, { "path": "/api/v1/TRA/partial", "method": "post" }, { "path": "/api/v1/test", "method": "get" } ] ```

Récupération des informations du token et des routes accessibles

$ curl --location \
--request GET 'https://api.myunisoft.fr/api/v1/key/info?mode=extended' \
--header 'Authorization: Bearer ' \
--header 'X-Third-Party-Secret: ' \

Retour JSON de l’API

```json { "target": { "type": "api", "schemaId": 80, "thirdPartyId": 101, "societyId": 127 }, "version": { "current": 1, "latest": 1, "beta": false }, "canBeActivated": true, "isActivated": true, "routes": [ { "path": "/api/v1/society/exercie", "method": "get" }, { "path": "/api/v1/society", "method": "get" }, { "path": "/api/v1/account", "method": "get" }, { "path": "/api/v1/diary", "method": "get" }, { "path": "/api/v1/TRA/partial", "method": "post" }, { "path": "/api/v1/test", "method": "get" } ] } ```

Interfaces

interface Route {
  path: `/api/v1/${string}`;
  method: 'get' | 'post' | 'put' | 'delete';
}

interface TokenDataWithRoutes {
  target: {
    type: "api" | "firm";
    schemaId: number;
    thirdPartyId: number;
    societyId: number;
  },
  version: {
    current: number;
    latest: number;
    beta: boolean;
  },
  canBeActivated: boolean;
  isActivated: boolean;
  routes: Route[];
}