Aller au contenu principal

Démarrage rapide

Bienvenue dans la documentation Matesst. Matesst exploite Matesst Turbo JIT (Powered by RunMat) et GNU Octave pour transformer vos algorithmes .m Script en API RESTful haute performance prêtes pour la production, sans aucune réécriture de code.

Suivez ces 5 étapes pour mettre en service votre première API.

1. Créer une APP​

Connectez-vous à la Dashboard Matesst. Accédez à la section Applications et cliquez sur Create APP.

Créer une APP

2. Préparer et téléverser le code source​

Tout d'abord, écrivez votre algorithme personnalisé. Le nom de la fonction dans votre code servira de point d'entrée à l'API. Par exemple, créez un fichier nommé my_math.m :

% Fichier : my_math.m
% Il s'agit de la fonction d'entrée de votre algorithme.
% Le nom du fichier (sans .m) devient le point de terminaison de l'API.

function [sum_val, prod_val] = my_math(a, b)
    % Un algorithme simple qui calcule la somme et le produit
    sum_val = a + b;
    prod_val = a * b;
end

Compressez ces fichiers directement au format ZIP (par exemple, my_math.zip). Matesst prend entièrement en charge les structures de projet complexes ; vous êtes libre d'organiser vos scripts dans des sous-dossiers au sein de l'archive ZIP.

Ensuite, accédez à la section My Apps, sélectionnez votre application et téléversez le package ZIP. Matesst analysera automatiquement les points d'entrée.

Téléverser ZIP

3. Gérer et Autoriser​

Sur la page des détails de l'application, vous pouvez surveiller l'état du déploiement. Chaque application possède sa propre API Key unique. Conservez cette clé en lieu sûr, car elle constitue l'identifiant pour appeler l'API de cette application spécifique.

Gérer les APPs

4. Facturation et utiliser un code​

Matesst utilise un système de crédits. Vous pouvez consulter votre Solde actuel (Balance) sur la page Orders. Si vous possédez un code secret de carte, saisissez le numéro de carte et le mot de passe pour échanger des Crédits instantanément.

Facturation

5. Surveiller les journaux d'appels​

Consultez l'historique d'exécution détaillé dans la section Logs. La facturation est basée sur le temps de calcul : 1 Crédit est consommé par seconde (1 Credit/s). Cela vous aide à auditer les coûts en temps réel.

Journaux

Votre première requête​

Une fois active, appelez votre application via une requête POST. Voici un exemple d'appel de la fonction my_math définie ci-dessus. N'oubliez pas d'utiliser l'API Key spécifique à votre application :

curl -X POST https://api.matesst.com/api/v2/my_math \
  -H "Authorization: Bearer YOUR_APP_SPECIFIC_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "params": [10, 20],
    "nargout": 2
  }'

Règles d'emballage des résultats (Results Wrapping)​

La structure du champ results dépend du nargout et du type de données renvoyées :

  • Nombre unique avec nargout = 1 : results renvoie le nombre directement.
  • Sinon : results est toujours enveloppé dans un tableau. Par exemple, si une fonction renvoie un tableau [1, 2, 3] avec nargout = 1, la réponse sera [[1, 2, 3]].

Exemple : Nombre unique (nargout = 1)​

{
  "results": 30,
  "status": "success"
}

Exemple : Sorties multiples (nargout = 2)​

{
  "results": [30, 200],
  "status": "success"
}

Exemple : Sortie de tableau (nargout = 1)​

{
  "results": [[1, 2, 3]],
  "status": "success"
}

Consultez la Référence API.