Démarrer avec OnPoint API

Remarque : Si vous êtes un utilisateur existant de Caseware Cloud API et que vous avez implémenté la V1, planifiez votre transition vers la V2. Si vous êtes un nouvel utilisateur, commencez par la V2. Tous les exemples sont tirés de la V2.

Caseware Cloud API fournit un ensemble d'opérations API pour automatiser la gestion des données de votre cabinet, telles que les clients, les utilisateurs, les groupes, les permissions et plus encore.

L'application SDK illustre ce qui suit :

• Points d'extrémité disponibles et opérations sur chaque point d'extrémité

• Paramètres d'entrée et de sortie pour chaque opération

• En-têtes requis et en-têtes de réponse

Authentification et autorisation

En enregistrant un client API et en obtenant un jeton API, vous pouvez envoyer des demandes aux points d'extrémité de l'API du cloud. L'API de Caseware Cloud est structurée autour de REST. Les URL prévisibles orientées ressources fournissent des réponses codées en JSON, ainsi que des codes de réponse HTTP standard.

Cloud API respecte les exigences d'authentification du flux d'octroi des informations d'identification du client du protocole OAuth 2.0. Ce flux est conçu pour des communications confidentielles, de serveur à serveur, sans utilisateur final.

Pour commencer :

1. Obtenir un identifiant et un secret client. Pour plus d'informations, reportez-vous à la section Paramètres de l'entreprise - Intégration .

2. Ensuite, utilisez l'ID et le secret du client générés pour obtenir un jeton d'API sur POST /auth/token :

requests

curl --location 'https://{region}.casewarecloud.com/{firm}/ms/caseware-cloud/api/v2/auth/token' \ --header 'accept : application/json' \N-header 'Content-Type : application/json' \N --data '{ "ClientId" : "966592b3-8586-4541-9909-f7a901ef0b9a", "ClientSecret": "sg1eb53tkbn6dez0momdxr0gm87fih1kkoekm40u", "Langue" : "en" }'

Réponse

Code d'état : 200

              {"Token" : YTA1NGNiOTgtOWJjOS02NDg5LWIyYTgtZTZhNDA5MDJiNGQwOjk1Y2U2YmRjLWUzMDktMmMxZS00ZDYyLWY5NWJmZGE4MGY1ZjpiYTk4OTc1YS04Mjc4LTRhZWEtOWVjOC0wMDcyM2FhMjRjNGY).

Utilisez le jeton API comme jeton porteur dans un en-tête d'autorisation pour effectuer des demandes API supplémentaires. Le jeton API reste valide pendant 30 minutes.

Durée de vie de la session

Chaque authentification de l'API Cloud génère une nouvelle session qui dure 30 minutes et qui n'invalide pas les sessions précédentes. La réinitialisation du secret d'un client invalide toutes les sessions existantes de ce client API. Par conséquent, une nouvelle autorisation est nécessaire.

Politique de plafonnement des taux

La limite de débit a pour but d'éviter que les ressources de l'API en nuage ne soient épuisées. Lorsqu'un client de l'API fait une demande, la disponibilité des ressources est temporairement réduite et reconstituée après un certain délai.

Si aucune ressource n'est disponible, le statut HTTP 429 (trop de demandes) est renvoyé. Vous pouvez utiliser l'en-tête de réponse ratelimit pour déterminer le nombre restant de demandes, la capacité de rafale, le taux de réapprovisionnement et le nombre de jetons demandés. L'algorithme du "token bucket" régule les demandes entrantes. Imaginez un seau de jetons. Lorsqu'une demande d'API est faite, un jeton doit être prélevé dans le panier pour que la demande soit traitée. La demande d'API est rejetée si aucun jeton n'est disponible dans le panier. Les jetons sont automatiquement ajoutés à la réserve au taux de réapprovisionnement au fur et à mesure que les demandes d'API consomment des jetons de la réserve disponible.

En-têtes de réponse

Remarque : Les valeurs de la configuration de limitation de débit sont susceptibles de changer. Ces valeurs ne doivent pas être codées en dur.

Voir la documentation de l'API

Les points de terminaison et les paramètres de l'API Cloud sont décrits dans l'application Caseware Cloud SDK :

Afficher la compatibilité API :

1. Dans votre navigateur, allez à cette URL :

https://<region>.casewarecloud.com/<firm>/sdk

2. Sur la gauche, développez /caseware-cloud
3. Sélectionnez la version que vous utilisez.
4. Utilisez la fonction de recherche pour trouver l'opération dont vous avez besoin :

Les paramètres de requête qui peuvent être utilisés dans l'API de votre demande sont décrits.

Voir le format de l'URL de la demande en développant le menu déroulant de la signature du point de terminaison :

5. Reportez-vous aux exemples de réponses à droite pour obtenir des listes et des descriptions des données que vous pouvez vous attendre à trouver dans la réponse.