Référence API

Documentation API complète avec exemples, points de terminaison et extraits de code pour intégrer les services TechRam.

Bientôt Disponible: Notre documentation API complète est actuellement en développement. Nous fournirons notre API complète dès que possible. Restez à l'écoute pour les mises à jour!

1. Introduction

L'API TechRam permet aux développeurs d'intégrer les services TechRam dans leurs applications. Notre API RESTful fournit un accès programmatique aux fonctionnalités TechRam, vous permettant de créer des intégrations personnalisées et d'automatiser les flux de travail.

Cette documentation couvrira l'authentification, les points de terminaison, les formats de requête/réponse, la gestion des erreurs et les meilleures pratiques pour utiliser l'API TechRam.

2. Authentification

Toutes les requêtes API nécessitent une authentification à l'aide de clés API. Incluez votre clé API dans les en-têtes de requête:

Authorization: Bearer YOUR_API_KEY

Les clés API peuvent être générées à partir du tableau de bord de votre compte TechRam. Gardez vos clés API sécurisées et ne les exposez jamais dans le code côté client ou les dépôts publics.

3. URL de Base

Toutes les requêtes API doivent être effectuées à l'URL de base suivante:

https://api.techramllc.com/v1

Tous les points de terminaison sont relatifs à cette URL de base. Par exemple, pour accéder au point de terminaison des projets, vous utiliseriez:

https://api.techramllc.com/v1/projects

4. Points de Terminaison API

L'API TechRam fournit les points de terminaison suivants:

Projets

GET /projects

Récupérer une liste de tous les projets associés à votre compte.

Créer un Projet

POST /projects

Créer un nouveau projet. Paramètres requis:

Paramètre	Type	Requis	Description
name	string	Oui	Nom du projet
description	string	Non	Description du projet

5. Format de Requête et Réponse

Format de Requête

Toutes les requêtes doivent inclure les en-têtes suivants:

                    Content-Type: application/json
Authorization: Bearer YOUR_API_KEY
                

Les corps de requête doivent être encodés en JSON.

Format de Réponse

Toutes les réponses sont renvoyées au format JSON. Une réponse de succès typique:

                    {
  "success": true,
  "data": { ... },
  "message": "Operation successful"
}
                

6. Gestion des Erreurs

L'API utilise des codes de statut HTTP standard pour indiquer le succès ou l'échec:

200 OK: Requête réussie
201 Created: Ressource créée avec succès
400 Bad Request: Paramètres de requête invalides
401 Unauthorized: Authentification requise ou clé API invalide
404 Not Found: Ressource non trouvée
500 Server Error: Erreur serveur interne

Les réponses d'erreur incluent un champ message avec des détails sur ce qui s'est mal passé.

7. Limitation du Débit

Pour assurer une utilisation équitable, l'API implémente une limitation du débit:

Plans standard: 100 requêtes par minute
Plans premium: 500 requêtes par minute
Plans entreprise: Limites personnalisées

Les informations de limitation du débit sont incluses dans les en-têtes de réponse. Si vous dépassez la limite, vous recevrez une réponse 429 Trop de Requêtes.

8. Exemples de Code

Exemple JavaScript

                    fetch('https://api.techramllc.com/v1/projects', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
  }
})
.then(response => response.json())
.then(data => console.log(data));
                

Exemple PHP

                    $ch = curl_init('https://api.techramllc.com/v1/projects');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'Authorization: Bearer YOUR_API_KEY',
  'Content-Type: application/json'
]);
$response = curl_exec($ch);
curl_close($ch);
                

9. Support et Ressources

Pour une aide et des ressources supplémentaires:

Besoin d'Aide? Notre équipe de support est disponible 24/7. Contactez-nous à info@techramllc.com pour les questions liées à l'API.