SDKs officiels (TS + Python)

SDKs TypeScript et Python pour intégrer l'API publique en quelques lignes.

Les deux SDKs sont portés sur l'API v2 (2026-10-09). Leurs types sont désormais générés depuis le contrat OpenAPI versionné, et une étape de CI échoue s'ils en dérivent.

Ils visaient /api/v1 jusque-là ; cette couche a été retirée de l'API publique, et ils répondaient donc 404 sur tout.

⚠️ Ces SDKs ne sont pas à disposition des intégrateurs aujourd'hui.

Ni l'un ni l'autre n'est publié sur un registre — mesuré le 2026-10-09, @arch-platform/sdk et arch-platform-sdk renvoient tous deux 404, et aucun compte npm ou PyPI n'existe pour les y mettre.

Et l'installation « depuis les sources », que cette page indiquait précédemment, ne marche pas davantage : le dépôt est privé. La commande était donc inexécutable pour son lecteur.

Utilisez l'API directement en HTTP. Toutes les recettes sont à jour, et couvrent l'intégralité de ce que font les SDKs : Exemples et Provisioning.

Ce qui est prêt, si vous en avez besoin. Les deux paquets sont portés sur l'API v2, construits, installables et testés (0.2.0) :

  • leurs types sont générés depuis le contrat OpenAPI, avec une étape de CI qui échoue s'ils en dérivent ;
  • l'archive npm s'importe en CommonJS et en ESM, types inclus ;
  • la roue Python s'installe et valide les réponses avec pydantic.

Il ne manque qu'un compte de registre. Si l'accès aux SDKs vous est utile, écrivez à support@arch-platform.com : la publication est à une commande près.

Les deux SDKs exposent les mêmes quatre ressources — businessFunctions / business_functions, applications, invitations et members — avec la même sémantique. La différence est uniquement idiomatique (camelCase en TypeScript, snake_case en Python).

LangagePaquetVersion minimale
TypeScript@arch-platform/sdkNode ≥ 18
Pythonarch-platform-sdkPython ≥ 3.10

⚠️ Python 3.10 et non 3.9 : les modèles générés utilisent la syntaxe X | None, que pydantic évalue à l'exécution et qui n'existe pas avant 3.10. Cette page annonçait 3.9.

Quick start

import { ArchClient } from "@arch-platform/sdk";

const arch = new ArchClient({ token: process.env.ARCH_PAT! });

// Une page — la réponse est ENVELOPPÉE : { items, page }
const page = await arch.applications.list({ status: "LIVE" });
console.log(page.items.length, "sur", page.page.totalItems);

// Ou tout, curseurs suivis jusqu'au bout
const toutes = await arch.applications.listAll({ status: "LIVE" });

// Inviter quelqu'un
const invitation = await arch.invitations.create({
  email: "jane.doe@acme.com",
  arbRole: "architect",
});
import os
from arch_platform import ArchClient

arch = ArchClient(token=os.environ["ARCH_PAT"])

# Une page — la réponse est ENVELOPPÉE
page = arch.applications.list(status="LIVE")
print(len(page.items), "sur", page.page.total_items)

# Ou tout, curseurs suivis jusqu'au bout
toutes = arch.applications.list_all(status="LIVE")

# Inviter quelqu'un
invitation = arch.invitations.create(
    email="jane.doe@acme.com",
    arb_role="architect",
)

⚠️ Ce qui change pour qui utilisait la version v1

Avant (v1)Maintenant (v2)
arch.functions.tree()arch.businessFunctions.tree()
arch.functions.posi()arch.businessFunctions.tree({ includeApplications: true })
arch.functions.flat()arch.businessFunctions.list()
arch.functions.search(q)arch.businessFunctions.list({ q })
arch.functions.byApplication(c)arch.businessFunctions.list({ applicationCode: c })
arch.functions.stats()arch.businessFunctions.statistics()
arch.applications.get(code)arch.applications.get(applicationId) — ⚠️ UUID
arch.invitations.invite(…)arch.invitations.create(…)
arch.invitations.members()arch.members.list()
arch.invitations.revokeMember(sub)arch.members.remove(memberId)
e.errorCodee.code — ⚠️ voir ci-dessous

errorCode n'a jamais fonctionné. Les deux SDKs lisaient ce champ, mais le corps d'erreur l'appelle code depuis l'unification des formats. L'attribut valait donc toujours undefined / None, et tout routage métier fondé sur lui ne s'est jamais déclenché.

Corrigé : e.code, plus e.traceId (à donner au support) et e.errors (le détail par champ d'une erreur de validation), qui n'étaient pas exposés du tout.

Les collections sont paginées

// Une page — { items, page }
const page = await arch.applications.list({ status: "LIVE" });

// Ou TOUT, curseurs suivis jusqu'au bout
const toutes = await arch.applications.listAll({ status: "LIVE" });

⚠️ Préférez listAll() dès que vous voulez l'ensemble : lire la première page donne au plus 200 éléments sans le dire. En Python, list_all().

Verrouillage optimiste

const { data, etag } = await arch.members.getWithEtag(memberId);
await arch.members.changeRole(memberId, "viewer", { ifMatch: etag ?? undefined });

Si quelqu'un a modifié le membre entre-temps, l'appel est refusé en 412 — plutôt que d'écraser son travail en silence.

Ressources

businessFunctions / business_functions

Méthode (TS)Méthode (Python)Endpoint
list(params)list(**params)GET /business-functions
listAll(params)list_all(**params)idem, curseurs suivis
get(functionId)get(function_id)GET /business-functions/{functionId}
tree()tree()GET /business-functions/tree
tree({ includeApplications: true })tree(include_applications=True)GET /business-functions/tree?include=applications
statistics()statistics()GET /business-functions/statistics

applications

Méthode (TS)Méthode (Python)Endpoint
list(params)list(**params)GET /applications
listAll(params)list_all(**params)idem, curseurs suivis
get(applicationId)get(application_id)GET /applications/{applicationId}

⚠️ get() prend un UUID, plus le code métier. Aucune correspondance publique code → UUID : lisez l'applicationId dans la liste.

invitations

Scope PAT write pour create et revoke, read pour les lectures. Le porteur du PAT doit être tenant-admin.

Méthode (TS)Méthode (Python)Endpoint
list(params)list(**params)GET /tenant/invitations
listAll(params)list_all(**params)idem, curseurs suivis
get(invitationId)get(invitation_id)GET /tenant/invitations/{invitationId}
create(body)create(email=…, arb_role=…)POST /tenant/invitations → 201 + Location
revoke(invitationId)revoke(invitation_id)POST /tenant/invitations/{invitationId}/revoke → 200

⚠️ revoke est un POST, pas un DELETE : la révocation est une transition d'état — la ligne survit en REVOKED et reste listée.

members — NOUVEAU

Méthode (TS)Méthode (Python)Endpoint
list(params)list(**params)GET /tenant/members
listAll()list_all()idem, curseurs suivis
get(memberId)get(member_id)GET /tenant/members/{memberId}
getWithEtag(memberId)get_with_etag(member_id)idem, + l'ETag
changeRole(memberId, role, { ifMatch })change_role(member_id, role, if_match=…)PATCH /tenant/members/{memberId}
remove(memberId, { ifMatch })remove(member_id, if_match=…)DELETE /tenant/members/{memberId} → 204

⚠️ changeRole remplace les rôles ; il ne s'y ajoute pas. Et un membre n'apparaît qu'une fois dans list(), avec roles en tableau — la v1 rendait une ligne par rôle accordé.

Gestion d'erreurs

Le backend renvoie en cas d'erreur un body RFC 9457 (Problem Details). Les SDKs wrappent ça dans une exception typée :

import { ArchApiError, ArchNetworkError } from "@arch-platform/sdk";

try {
  await arch.invitations.invite({ email: "dup@acme.com", arbRole: "viewer" });
} catch (e) {
  if (e instanceof ArchApiError && e.errorCode === "ALREADY_INVITED") {
    console.log("Déjà invité");
  } else if (e instanceof ArchNetworkError) {
    console.log("Retry plus tard");
  } else {
    throw e;
  }
}
from arch_platform import ArchApiError, ArchNetworkError

try:
    arch.invitations.invite(email="dup@acme.com", arb_role="viewer")
except ArchApiError as e:
    if e.error_code == "ALREADY_INVITED":
        print("Déjà invité")
    else:
        raise
except ArchNetworkError:
    print("Retry plus tard")

Configuration avancée

const arch = new ArchClient({
  token: "arc_pat_…",
  baseUrl: "https://api-staging.arch-platform.com/api/v2", // env override
  timeoutMs: 60000,
  defaultHeaders: { "X-Request-Id": crypto.randomUUID() },
});
arch = ArchClient(
    token="arc_pat_…",
    base_url="https://api-staging.arch-platform.com/api/v2",
    timeout=60.0,
    default_headers={"X-Request-Id": str(uuid4())},
)

Le client Python supporte aussi le context manager pour fermer proprement les connexions HTTP :

with ArchClient(token="...") as arch:
    apps = arch.applications.list()
# connexion fermée automatiquement

Voir aussi

On this page