Zoho Creator 6 - Tutoriel pour comprendre les API personnalisées

Découvrez les API personnalisées et comment définir leurs actions à l'aide des fonctions Deluge, qui peuvent ensuite être exposées en tant qu'API et appelées à partir d'une plateforme externe. Cela permettra de maximiser l'efficacité opérationnelle entre plusieurs plateformes, y compris Zoho Creator, et de réduire la difficulté de programmer des opérations complexes à travers des systèmes externes.

API personnalisées :

1. Ne peuvent être créées que dans les plans payantsde Creator, alors que les utilisateurs des plans d'essai peuvent les invoquer.
2. Ne peuvent être créées, autorisées et gérées que par le super administrateur et les administrateurs, tandis que les autres utilisateurspeuvent y accéder.
3. Sont disponibles dans les centres de données des États-Unis (.com), de l'Europe (.eu), de l'Inde (.in) et de l'Australie (.au).

Dans Creator, les API personnalisées permettent aux développeurs d'obtenir des fonctionnalités spécifiques adaptées à leurs besoins en utilisant les fonctions existantes dans leurs applications. Alors que les API de développeur (API REST) exécutent une action fixe (prédéfinie) lorsqu'elles sont invoquées, les API personnalisées peuvent être scriptées pour exécuter des actions définies par l'utilisateur à partir de plates-formes externes. Cela signifie que les utilisateurs peuvent effectuer des actions autres que celles prédéfinies sur les données de leur application Creator à partir d'applications tierces en invoquant leurs fonctions en tant qu'API personnalisée. Cette personnalisation garantit que l'API personnalisée s'aligne précisément sur les besoins de votre organisation, optimisant ainsi les performances et l'efficacité.

Les API personnalisées vous permettent également d'intégrer vos applications à des services tiers, ce qui vous permet d'étendre les capacités de votre application en tirant parti de ressources externes. En outre, ces API encapsulent votre logique d'entreprise, ce qui facilite sa maintenance et sa mise à jour en un seul endroit. Cela signifie que toute modification des processus commerciaux peut être mise en œuvre dans l'API elle-même, sans nécessiter de modifications de l'ensemble de l'application.

Dans Creator, l'API personnalisée peut être créée et gérée dans le Custom API builder. Ce constructeur vous permet de définir les actions à exposer en tant qu'API à l'aide d'une fonction Deluge existante (qui a l'action définie) et d'invoquer l'API à partir d'une plateforme externe en utilisant l'URL de point final générée automatiquement à l'adresse .

Après avoir invoqué votre API personnalisée, vous pouvez consulter le statut de vos hits API(succès/échec) et leurs journaux d'erreurs dans la page Résumé de l'API .

Remarque :

1. Le nombre d'accès à l'API sera comptabilisé séparément des accès à l'API REST en termes de tarification.
2. Actuellement, vous ne pouvez utiliser que les fonctions Delugedéjà configurées en tant qu'API personnalisées. Cela signifie que vous ne pouvez pas invoquer des fonctions cloud écrites à l'aide de scripts Javaet NodeJSen tant qu'API personnalisée.
3. Vous ne pouvez pas tester vos API personnalisées dans un environnement de développement puisque seules les fonctions Deluge disponibles dans l'environnement de production peuvent être exposées en tant qu'API personnalisées.

III-A. Fonctionnalités des API personnalisées dans Creator▲

III-B. Comment les API personnalisées sont-elles construites dans Creator ?▲

III-C. Composants d'une API personnalisée dans Creator▲

{
  "name": "John",
  "age": 30,
  "email": "john@zylker.com"
}

     {
  "user": {
    "id": 12345,
    "name": "Alisa",
    "email": "alisa@zylker.com",
    "age": 28,
    "address": {
      "street": "123 Main St",
      "city": "Anytown",
      "country": "Zylkerland"
    },
    "orders": [
      {
        "order_id": 1001,
        "total_amount": 75.5,
        "status": "delivered"
      },
      {
        "order_id": 1002,
        "total_amount": 102.2,
        "status": "pending"
      }
    ]
  },
  "status": "success",
  "message": "Données de l'utilisateur récupérées avec succès"
}

III-D. Réponse▲

III-E. Fonction▲

III-F. Résumé▲

Après avoir créé votre API personnalisée, vous pouvez afficher les détails essentiels de l'API personnalisée, l'application dans laquelle elle est utilisée, ainsi que les détails de sa création et de sa mise à jour. Vous pouvez également consulter le nombre d'accès à l'API par les utilisateurs qui l'ont invoquée, la date et l'heure du journal, le code d'état et l'état de l'API(succès ou échec). En outre, vous pouvez également consulter les journaux de l'API à différentes périodes : quotidienne, hebdomadaire et mensuelle.

1. Les journaux de l'API affichent par défaut les journaux des 30 derniers jours et au maximum les journaux des 60 derniers jours.
2. Seuls le superadministrateur et les administrateurs peuvent voir les hits de l'API, c'est-à-dire que les utilisateurs ne peuvent pas voir les hits de l'API.

Supposons que vous ayez créé une application de gestion scolaire comportant des modules distincts pour les élèves, les enseignants, les parents et le personnel non enseignant. En tant qu'administrateur de l'application, vous devez traiter les données provenant du dispositif iOT de suivi des bus installé dans vos bus scolaires et accessible aux chauffeurs de bus de votre école. Supposons que vous ayez les deux exigences suivantes.

1. Récupérer les adresses de ramassage du personnel, des élèves et du personnel non enseignant dans toutes les zones couvertes avant le début d'une bande.
2. Soumettre l'assiduité des élèves et la vitesse moyenne du trajet à la fin de chaque trajet.

Pour réaliser ce qui précède, vous aurez généralement besoin d'invoquer au moins cinq API.

1. Trois API Get Recordspour récupérer les adresses dans trois rapports distincts.
2. Deux APIAdd Recordspour ajouter des détails sur le trajet et marquer les présences de ce jour en tant qu'enregistrements.

En outre, vous devez récupérer les enregistrements des élèves absents et informer les parents respectifs par le biais de notifications SMS.

Pour réduire le nombre d'API créées et obtenir la même fonctionnalité, vous pouvez créer une API personnaliséeet utiliser une fonction Deluge existante qui a le login combiné à invoquer lorsque l'API personnalisée est appelée.

La vidéo ci-dessous montre l'exécution d'une API personnalisée pour récupérer les adresses de trois rapports distincts.

https://workdrive.zohoexternal.com/embed/e5jyw328ac5df76d14485b5d4553ce1f88179?toolbar=false&start=0

1. Gestion d'un hôpital : Supposons que vous soyez propriétaire d'une clinique et que vous ayez créé une application de gestion hospitalière à l'aide de Creator. Vous souhaitez récupérer des informations vitales à partir de dispositifs médicaux (équipés de capteurs) portés par vos patients, afin que les médecins soient immédiatement informés, surveillent leurs signes vitaux et fournissent une assistance médicale si nécessaire. Vous pouvez configurer une API personnalisée qui est invoquée chaque fois qu'une lecture anormale se produit (en tenant compte de diverses données vitales telles que la fréquence cardiaque, la pression artérielle, les niveaux d'oxygène, et ainsi de suite). L'appareil envoie ces détails via une requête API sous forme de notification mobile au médecin concerné en fonction de sa disponibilité. Le médecin assigné peut être invité à remplir un formulaire contextuel dans Creator (pour les petites urgences) afin d'envoyer des conseils médicaux au personnel médical traitant. Le médecin peut également choisir si un rendez-vous est nécessaire immédiatement et réserver le plus tôt possible. Le patient reçoit l'avis médical prescrit ainsi que les détails du rendez-vous (le cas échéant), via la réponse de l'API. Ces données peuvent également être ajoutées aux formulaires de prise de rendez-vous et de détails sur le patient, respectivement.
2. Gestion des approbations: Supposons que vous ayez créé une application de gestion de projet à l'aide de Creator. Vos employés créent des documents de proposition dans un service externe, qui doivent être approuvés par vous (administrateur). En outre, vous devez ajouter un enregistrement dans votre application Creator chaque fois qu'un document est approuvé et conserver les enregistrements des documents rejetés. Vous pouvez créer une API personnalisée qui est invoquée lorsqu'un document est soumis pour approbation à partir du service externe. Cela déclenchera le flux de travail d'approbation dans Creator, qui lancera le processus d'approbation des documents et changera le statut du document en "Approuvé". Un enregistrement sera ajouté dans les rapports Détails du projet et Détails du devis respectivement. Si un document est rejeté, le statut du document sera marqué comme "rejeté" et un enregistrement sera ensuite ajouté dans les rapports Détails du projet et Feedback du document respectivement.

Sur la page d'accueil de votre compte Creator, accédez à la section Microservices et sélectionnez l'onglet Custom API . Ensuite, cliquez sur + Créer une API personnalisée. Le constructeur d'API personnalisées s'affiche. Découvrez comment vous pouvez créer des API personnalisées et utiliser leurs fonctionnalités au profit de votre entreprise.

https://workdrive.zohoexternal.com/embed/bx83gccc1d0965ccf49dd83c53fca33eaea82?toolbar=false&start=0

1. Le nom du lien de votre API personnalisée ne peut pas contenir de caractères spéciaux tels que !@#$%^&*.>.
2. Les codes d'état de la réponse personnalisée peuvent être compris entre 100 et 599.
3. Les codes de réponse dans la réponse personnalisée doivent être compris entre 1 et 9999 et ne peuvent pas contenir de caractères spéciaux tels que ! @#$%^&*.>.
4. Lorsque vous modifiez l'étendue de l'utilisateur de votre API personnalisée en la faisant passer d'Utilisateurs sélectifs à Admins Only, tous les utilisateurs que vous avez précédemment ajoutés seront supprimés.
5. Si vous fermez le Custom API builder sans enregistrer, vos modifications seront toujours enregistrées en tant que brouillon et vous pourrez continuer à les modifier à tout moment à partir de Microservices > Custom API > carte d'API personnalisée requise.
6. Lorsque vous invoquez une API désactivée, une réponse vide sera renvoyée, c'est-à-dire que l'invocation d'une API désactivée produira un enregistrement dans les journaux d'API mais ne sera pas enregistrée en tant qu'API hit.
7. Avant de pouvoir supprimer une fonction utilisée dans votre API personnalisée, vous devrez supprimer l'API personnalisée associée avant de supprimer la fonction correspondante.

1. Dans l'onglet Response, vous pouvez ajouter jusqu'à 50 codes d'état.
2. Vos codes de réponse personnalisés ne peuvent contenir que 4 chiffres au maximum.

1. Créer et gérer des API personnalisées
2. API Rest dans Creator

Nous tenons à remercier Malick pour la mise au gabarit et TODO pour la relecture orthographique.