Documentation API

Introduction à la Documentation

Chez BitLien, nous mettons à votre disposition une documentation détaillée et claire pour faciliter l'intégration de notre API dans vos applications. Que vous soyez un développeur débutant ou expérimenté, nos guides techniques vous accompagnent pas à pas.

Cette documentation couvre :

• Le guide de démarrage rapide pour une mise en route immédiate,
• La référence complète de l'API avec toutes les routes, paramètres et réponses,
• Des exemples pratiques de SDK en Python, Node.js et Go,
• Des conseils sur la sécurité et la gestion des erreurs,
• Les meilleures pratiques pour automatiser et orchestrer vos flux de données.

Guide de démarrage rapide

Pour commencer à utiliser l'API BitLien, suivez ces étapes simples :

1. Créez un compte sur la plateforme BitLien et obtenez votre clé API.
2. Configurez vos endpoints de données à connecter via les webhooks sécurisés.
3. Utilisez nos SDK pour intégrer rapidement les appels API dans votre code.
4. Testez vos flux de données en temps réel avec notre environnement sandbox.
5. Déployez en production en toute confiance grâce à nos mesures de sécurité avancées.

curl -X POST https://api.bitlien.io/v1/connect \
  -H "Authorization: Bearer VOTRE_CLE_API" \
  -H "Content-Type: application/json" \
  -d '{
    "source": "crm",
    "destination": "erp",
    "mapping": {
      "client_id": "customer_id",
      "order_total": "total_amount"
    }
  }'

Référence API complète

Notre API RESTful suit des standards stricts pour garantir une intégration fluide et performante. Voici un aperçu des principales routes disponibles :

• POST /v1/connect : Créer une connexion entre deux services.
• GET /v1/connections : Lister toutes vos connexions actives.
• PATCH /v1/connections/{id} : Mettre à jour une connexion existante.
• DELETE /v1/connections/{id} : Supprimer une connexion.
• GET /v1/logs : Consulter les logs d’activité pour le débogage.

Toutes les requêtes nécessitent une authentification via un token Bearer dans l’en-tête HTTP Authorization. Les réponses sont fournies en JSON avec des codes HTTP standard.

Exemples de SDK

Pour vous faciliter l’intégration, nous proposons des SDK officiels qui encapsulent les appels API et gèrent automatiquement l’authentification et la gestion des erreurs.

Python

from bitlien_sdk import BitLienClient

client = BitLienClient(api_key="VOTRE_CLE_API")

connection = client.create_connection(
    source="crm",
    destination="erp",
    mapping={"client_id": "customer_id", "order_total": "total_amount"}
)

print(connection.status)

Node.js

const BitLienClient = require('bitlien-sdk');

const client = new BitLienClient('VOTRE_CLE_API');

async function createConnection() {
  const connection = await client.createConnection({
    source: 'crm',
    destination: 'erp',
    mapping: { client_id: 'customer_id', order_total: 'total_amount' }
  });
  console.log(connection.status);
}

createConnection();

Go

package main

import (
  "fmt"
  "github.com/bitlien/bitlien-sdk-go"
)

func main() {
  client := bitlien.NewClient("VOTRE_CLE_API")

  conn, err := client.CreateConnection(bitlien.ConnectionRequest{
    Source:      "crm",
    Destination: "erp",
    Mapping: map[string]string{
      "client_id":  "customer_id",
      "order_total": "total_amount",
    },
  })
  if err != nil {
    panic(err)
  }
  fmt.Println(conn.Status)
}

Sécurité et bonnes pratiques

La sécurité des données étant au cœur de notre solution, nous recommandons :

• De toujours utiliser HTTPS pour vos appels API.
• De protéger votre clé API et de la renouveler régulièrement.
• De limiter les permissions de vos tokens en fonction des besoins.
• De surveiller les logs d’activité pour détecter toute anomalie.

Notre infrastructure applique des contrôles d’accès stricts et chiffre toutes les données en transit et au repos.

FAQ rapide

Comment obtenir ma clé API ?

Après inscription sur BitLien, accédez à votre tableau de bord pour générer et gérer vos clés API.

Quels formats de données sont supportés ?

Nous supportons les formats JSON, XML et CSV pour les entrées et sorties.

Y a-t-il des limites de requêtes ?

Oui, selon votre plan tarifaire. Consultez la page Tarifs pour plus de détails.

Puis-je tester l’API sans risque ?

Oui, un environnement sandbox est disponible pour tester vos intégrations sans impact en production.