API entrante
Gratuit
Intégrations
Permettez aux systèmes externes d'accéder à vos données Nixa via API REST.
Prêt à simplifier votre travail?
Installez votre première plugin en 30 secondes. Aucune carte de crédit requise.
Préférences de cookies
Nous utilisons des cookies essentiels pour la sécurité et l'accès. Les cookies optionnels restent désactivés sauf si vous les choisissez, et les tableaux de bord intégrés fonctionnent en mode essentiel seulement.
Comment ça fonctionne
1
Générez une clé API: dans les paramètres de votre espace de travail
2
Authentifiez: vos requêtes avec cette clé dans les en-têtes
3
Accédez à vos données: par des points d'accès REST standards
Authentification
Toute requête exige une clé API transmise dans l'en-tête `X-API-Key` :
```bash
curl -X GET "https://api.nixa.ca/v1/entities" \
-H "X-API-Key: ${NIXA_API_KEY}"
```
Points d'accès offerts
### Santé et documentation
`GET /v1/health` - Vérifier que l'API publique répond
`GET /v1/openapi.json` - Récupérer le contrat OpenAPI
### Entités
`GET /v1/entities` - Lister toutes les entités de votre espace de travail
`GET /v1/entities/:id` - Obtenir le détail et le schéma d'une entité
### Enregistrements
`GET /v1/entities/:id/records` - Lister les enregistrements avec filtrage et pagination
`GET /v1/entities/:id/records/:recordId` - Obtenir un enregistrement précis
`POST /v1/entities/:id/records` - Créer un enregistrement
`PATCH /v1/entities/:id/records/:recordId` - Mettre à jour un enregistrement
`DELETE /v1/entities/:id/records/:recordId` - Supprimer un enregistrement
### Filtrage et pagination
```bash
GET /v1/entities/123/records?status=active
GET /v1/entities/123/records?limit=50&offset=100
GET /v1/entities/123/records?sort=createdAt&order=desc
```
Sécurité
### Gestion des clés API
Créez autant de clés que nécessaire, avec des noms parlants
Révoquez une clé sur-le-champ en cas de compromission
Suivez la dernière utilisation de chaque clé
Les clés sont hachées - elles ne s'affichent qu'une fois, à la création
### Limitation de débit
Une limitation automatique protège votre espace de travail
Des seuils configurables pour chaque clé API
Des messages d'erreur clairs dès que la limite est atteinte
### Piste d'audit
Chaque accès à l'API est journalisé
Sachez quelle clé a consulté quelles données
Repérez rapidement les comportements inhabituels
Cas d'usage
Intégrations sur mesure — Reliez vos systèmes propriétaires à Nixa
Applications mobiles — Créez des expériences mobiles taillées pour vos équipes
Rapports — Alimentez vos outils d'informatique décisionnelle
Automatisation — Scriptez vos opérations en lot
Synchronisation — Gardez vos bases de données externes à jour
Objets connectés — Envoyez les données de vos capteurs vers Nixa
Format des réponses
Toutes les réponses suivent la même structure JSON :
```json
{
"data": [...],
"meta": {
"total": 150,
"limit": 25,
"offset": 0
}
}
```
Gestion des erreurs
Les erreurs renvoient le code HTTP approprié, accompagné du détail :
```json
{
"error": {
"code": "unauthorized",
"message": "Invalid or expired API key",
"details": {},
"requestId": "..."
}
}
```
Captures d'écran
Captures d'écran à venir
Inscrivez-vous pour essayer API entrante en direct — c'est encore mieux en action.
Intégrations