Documentation API Data Store du Groupe IDAIA

(IDAIA Group API Data Store documentation)

Introduction

L’API REST fournit une API de services Web pratique, puissante, simple pour interagir avec des applications mobiles, Web et avec des systèmes d'informations via une connexion Web. Cela vous offre une grande facilité d'intégration et de développement.

URL de base de l'API : https://api.api-datastore.com/api/v1.0/

Tous les appels de l'API commencent par cette URL à laquelle s'ajoute le chemin vers l'action désirée.
Exemple : https://api.api-datastore.com/api/v1.0/Company/byId/{id}

L'API est accessible uniquement via le protocole Https et accepte les requêtes HTTP POST ou GET. Les données envoyées en POST doivent respecter le format JSON.

Introduction

The REST API provides a practical, powerful and simple Web service API to interact with mobile and Web applications. Some of its advantages are very easy integration and development.

Base API URL : https://api.api-datastore.com/api/v1.0/

All API call starts with this URL to which the path to the required action is added.
Exemple : https://api.api-datastore.com/api/v1.0/Company/byId/{id}

The API can only be accessed using the Https protocol and accepts HTTP POST and GET requests. Data sent using POST must comply with JSON format.

Bien débuter

Pour interroger l'API, il est nécessaire d’utiliser une API Key passée en paramètre GET lors de chaque appel (voir partie Authentification). Cette API Key est unique pour chaque compte client, elle représente l’utilisateur auprès de l’API.

Attention : la consommation issue de cette API Key sera donc facturée sur le compte client correspondant.

Sécurité

L’API Key doit être utilisée pour des appels côté serveur (backend) pour garantir sa sécurité et éviter toute usurpation d’identité.
Il est possible de paramétrer une white liste d'IP's autorisées afin de limiter les appels à ces IP's dédiées correspondant au serveur backend exécutant les appels vers l'API.

Getting off to a good start

To query the API, an API Key passed as a GET parameter needs to be used for each call (See authentication part). This API Key is unique for each customer account, it represents the user for the API.

Caution : consumption using this API Key will therefore be billed to the corresponding customer account.

Security

The API Key must be used for backend server calls to guarantee its security and prevent identity theft.
A white list of authorized IPs can be configured to limit calls to these specific IPs corresponding to the backend server running the calls to the API

Authentification

Récupérer son API Key

Commencez par créer un compte démo "Testez gratuitement" ou connectez-vous sur votre espace client "Connexion" si vous avez déjà un compte. Depuis votre espace client, allez dans l’onglet « Ressources », rubrique «Clé API»

Utiliser l’API Key

Pour utiliser l’API Key, il suffit de la rajouter dans les paramètres des requêtes envoyées sous le format :

apikey={MonAPIKey}

Lors de la réception d’une demande, l’API vérifie la présence ainsi que la conformité de l’API Key utilisée. En cas contraire, une réponse HTTP 401 adaptée est renvoyée :
- Demande sans API Key : « Message : "L’autorisation a été refusée pour cette demande. " »
- API Key non valide : « Message : "Clé API n’est pas valide" »

Authentication

Retrieving your API Key

Start by creating a "Free trial" demo account or login to your customer area using "Connection" if you already have an account. From your customer area, go to the “Resources” tab, “API Keys” section

Using the API Key

To use the API Key, all you need to do is to add it to the parameters in sent requests in the following format:

apikey={MonAPIKey}

When it receives a request, the API checks for the presence and conformity of the API Key being used. If this check fails, a suitable HTTP 401 response is returned:
- Request without an API Key: " Message: "Authorization failed for this request." "
- Invalid API Key: "Message: "Invalid API key" "

Contrôles des appels API

Vérification de la route

Si la route n’a pas la bonne syntaxe, on renvoie une réponse 404 et un message donnant de l’information sur le contrôleur incorrect.

Vérification des paramètres obligatoire

Si un paramètre obligatoire est absent, la méthode renvoie une réponse 400 avec un message indiquant la syntaxe d’appel.

Exemple: "Message": "Syntaxe de la requête invalide, syntaxe correcte"

Gestion des Exceptions

Dès qu'une exception est levée, on envoie une réponse avec un message d’erreur et un statut de requête http.

STATUT DU RETOUR, LISTE DES CODES

Chaque appel à l'API donne lieu à une réponse retournant un code spécifique en fonction du résultat obtenu. L'analyse de ce code vous permet de vous assurer que la requête a été traitée avec succès.
Tous les codes >= 400 indiquent que la requête n'a pas été traitée avec succès par nos serveurs.

  • 200: OK
  • 204: OK, mais pas de résultat
  • 400: Paramètre manquant, ou valeur incorrecte
  • 401: Authentification nécessaire (jeton non précisé ou invalide)
  • 403: Action non autorisée (crédits épuisés, URL non autorisée, etc)
  • 404: Page inaccessible (URL inconnue / impossible d'accéder à l'adresse)
  • 500: Erreur inconnue, contactez-nous

API call checks

Route check

If the route has invalid syntax, a 404 response is returned along with a message giving information on the incorrect controller.

Mandatory parameter check

If a mandatory parameter is missing, the method returns a 400 response with a message indicating the call syntax.

Exemple: "Message": "Invalid request syntax, correct syntax"

Exception management

As soon as an exception occurs, a response is returned with an error message and an http request status.

RETURN STATUS, CODE LIST

Each API call results in a response returning a code specific to the result. Analyzing this code makes it possible to make sure the request was successfully processed.
All the codes >= 400 indicate that the request processing on our servers

  • 200: OK
  • 204: OK, but no result
  • 400: Missing parameter, or incorrect value
  • 401: Authentication required (no token or invalid token)
  • 403: Unauthorized action (no more credits, unauthorized URL, etc.)
  • 404: Page unavailable (Unknown URL / impossible to access the address)
  • 500: Unknown error, contact us