dRofus REST API.
Ce document fournit des documents de référence pour l'utilisation de l'API dRofus REST pour les données d'une base de données donnée. Pour la gestion de la base de données REST API, voir ceci : Admin system REST API
Cette API fournit un Open API specification décrivant l'API. Nous avons également une interface graphique interactive qui vous permet d'explorer cette API et de l'essayer dans le navigateur. Puisque nous exposons et documentons comment obtenir des propriétés spécifiques à une base de données/projet, nous vous demandons de vous connecter pour voir la documentation. Voir la section Authentification ci-dessous.
Fournir un feedback
Cette API est en version bêta et nous continuerons d'ajouter des fonctionnalités et des données à obtenir. N'hésitez pas à nous contacter et à nous faire part de vos commentaires sur les cas d'utilisation de l'API que vous souhaitez utiliser.
URLS
L'API est actuellement déployée sur les sites suivants. D'autres suivront
| URL | Gui | Swagger JSON |
|---|---|---|
| GUI | Open API Specification | |
| https://api-ca.drofus.com | GUI | Open API Specification |
| https://api-us.drofus.com | GUI | Open API Specification |
| https://api-au.drofus.com/ | GUI | Open API Specification |
Authentication
Actuellement, nous utilisons l'authentification de base (nom d'utilisateur et mot de passe). Le nom d'utilisateur se trouve sur le formulaire <db-name>/[project-id/]user-name[/language], où :
| Nom | Signification |
|---|---|
| db-name | Le nom du projet tel que vous le saisiriez dans dRofus Client |
| project-id | Id du projet. Habituellement'01'. Cette option n'est facultative que si la base de données ne contient qu'un seul projet. |
| user-name | Le nom avec lequel vous vous connectez dans le client dRofus |
| language | La langue dans laquelle vous voulez voir les données. Facultatif, et par défaut est la langue configurée pour la base de données |
Nous fournirons d'autres méthodes d'authentification à l'avenir.
Requêtes
Nous modélisons la syntaxe des requêtes sur le standard OData, mais actuellement nous n'en supportons qu'un petit sous-ensemble.
| Argument | Description | Sample | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| $select | Une liste de colonnes séparées par des virgules à retourner. id' sera toujours retourné | $select=name,architect_no | ||||||||||||||
| $orderby | Une liste de colonnes séparées par des virgules pour trier par. La direction de tri peut être spécifiée à l'aide de asc ou desc. par défault : asc. Si aucune commande n'est spécifiée, le résultat est trié par identifiant. | $orderby=name,architect_no desc, | ||||||||||||||
| $filter | Permet de limiter les lignes retournées. Une colonne peut avoir un critère pour filtrer par. La valeur du filtre peut être citée pour gérer les espaces et les chaînes incorporés. Actuellement, seuls'et' peuvent être utilisés pour combiner plusieurs filtres. Operators:
| $filter=created gt '2019-1-1' | ||||||||||||||
| $top | Nombre maximum de lignes à renvoyer. La valeur par défaut est 1000. Si le nombre de données disponibles est supérieur au nombre de données renvoyées, le résultat contiendra une valeur de RFC5988 valeur de l'en-tête | $top=123 | ||||||||||||||
| $skip | Combien de lignes à sauter sur l'ensemble des résultats. La valeur par défaut est 0 et peut être combinée avec $top pour implémenter la pagination. | $skip=100 |
RFC5988
Rfc5988 est un standard Internet pour naviguer entre les pages d'un ensemble de résultats. Essentiellement, il ressemble à ceci, et contient le lien complet pour les données supplémentaires :
<http://localhost/rooms?$skip=1&$top=1>; rel=\"next\">
Exemples
Exemples d'utilisation de l'API :