Authentification avec l'API de DataDocks

Avant d'effectuer des appels API vers DataDocks, vous devez authentifier vos requêtes à l'aide d'un jeton API. Cette page vous guidera à travers le processus d'authentification avec des exemples clairs.

Obtention de votre jeton API

Votre jeton API est unique à votre organisation et sert de clé numérique pour l'API DataDocks. Pour obtenir votre jeton :

1. Contactez l'équipe de support DataDocks à support@datadocks.com
2. Fournissez le nom de votre organisation et le sous-domaine de votre emplacement
3. Notre équipe générera un utilisateur API et vous fournira un jeton API

Important : Gardez votre jeton API sécurisé ! Ne le partagez pas dans des dépôts publics ou dans du code côté client.

Utilisation de votre jeton API

Incluez votre jeton API dans l'en-tête Authorization de toutes les requêtes en tant que Token :

Authorization: Token VOTRE_JETON_API

Format de la requête

Toutes les requêtes API doivent inclure :

1. L'en-tête Authorization avec votre jeton
2. Votre sous-domaine d'emplacement dans l'URL
3. La méthode HTTP appropriée (GET, POST, PUT, etc.)
4. L'en-tête Content-Type (pour les requêtes POST/PUT)

Exemples d'authentification

Exemple cURL

Voir l'exemple cURL

# Obtenir tous les rendez-vous
curl -H "Authorization: Token 12345abcde" https://toronto-acme.datadocks.com/api/v1/appointments

# Créer un nouveau rendez-vous
curl -H "Authorization: Token 12345abcde" \
     -H "Content-Type: application/json" \
     -X POST \
     -d '{"appointment": {"scheduled_at": "2023-10-01T09:00:00-04:00", "duration": 60}}' \
     https://toronto-acme.datadocks.com/api/v1/appointments

Exemple JavaScript

Voir l'exemple JavaScript

// Utilisation de l'API fetch
const fetchAppointments = async () => {
  const response = await fetch(
    "https://toronto-acme.datadocks.com/api/v1/appointments",
    {
      method: "GET",
      headers: {
        Authorization: "Token 12345abcde",
        "Content-Type": "application/json",
      },
    }
  );

  const data = await response.json();
  return data;
};

Exemple Python

Voir l'exemple Python

import requests

# Configuration
api_token = '12345abcde'
location_subdomain = 'toronto-acme'

# Obtenir tous les rendez-vous
headers = {
    'Authorization': f'Token {api_token}',
    'Content-Type': 'application/json'
}

response = requests.get(
    f'https://{location_subdomain}.datadocks.com/api/v1/appointments',
    headers=headers
)

appointments = response.json()

Meilleures pratiques de sécurité

Lorsque vous travaillez avec l'API de DataDocks, suivez ces meilleures pratiques de sécurité :

1. Stockez les jetons en toute sécurité — Ne codez jamais en dur les jetons dans le code côté client ou dans des dépôts publics
2. Utilisez les variables d'environnement — Stockez les jetons dans des variables d'environnement ou dans des stockage sécurisés de crédentials
3. Implémentez la rotation des jetons — Demandez un nouveau jeton périodiquement (tous les 90 jours)
4. Appliquez le principe du moindre privilège — Ne demandez que les autorisations dont vous avez besoin
5. Surveillez l'utilisation des jetons — Examinez régulièrement les journaux API pour détecter toute activité inhabituelle

Dépannage de l'authentification

Erreur	Cause possible	Solution
401 Unauthorized	Jeton invalide ou manquant	Vérifiez que votre jeton est correct et correctement formaté dans l'en-tête
403 Forbidden	Le jeton n'a pas les autorisations	Contactez le support pour vous assurer que votre jeton a les autorisations nécessaires
429 Too Many Requests	Limite de fréquence dépassée	Implémentez une stratégie de backoff exponentiel

Si vous continuez à rencontrer des problèmes d'authentification, contactez support@datadocks.com avec les détails de votre requête et la réponse d'erreur.