Netwo API

Netwo - API

Accès à l'API

l'URL de l'API est https://api.netwo.io/api/v1/{ressource}, toutes les requêtes doivent utiliser HTTPS. L'HTTP n'est pas accepté.

L'API Netwo s'appuie sur le standard REST et supporte les verbes HTTP standards, ainsi les requêtes et les réponses sont toutes au format JSON.
L'entête HTTP content-type doit être systématiquement défini et contenir application/json

Authentification

L'api Netwo utilise une clé d'API pour authentifier les requêtes. Celle-ci doit être transmise vie l'entête HTTP x-api-key.

Pour obtenir une clé d'accès à l'API, merci d'en faire la demande par e-mail à l'adresse [email protected]

Cette clé est associée à un ou plusieurs roles pour un ou plusieurs acteurs (tenant) c'est pourquoi il est nécessaire de communiquer l'identifiant (slug) de l'acteur au nom de qui on veut agir via l'entête x-actor-slug

Par conséquent les entêtes HTTP suivants doivent être envoyés à chaque requête,

content-type:application/json
x-actor-slug:[ACTOR_SLUG]
x-api-key:[API_KEY]

Test d'implémentation

Il est possible d'utiliser l'API en mode test afin de ne pas affecter vos données de production.
L'ajout de l'entête HTTP x-realm=test et l'utilisation d'une clé d'API dédiée permet de consommer l'API en mode test.

Conventions

Filtres

Certaines routes permettent de filtrer les résulats selon les conditions spécifiées par les opérateurs >=, <=, > et < décrits dans le tableau suivant:

Tri

Certaines routes permettent le tri des résultats sur un attribut en particulier en ajoutant le paramètre sort_by=[nom de l'attribut].[asc|desc]

Par exemple, pour trier les résultats selon la valeur du débit descendant :

https://api.netwo.io/api/v1/endpoint?sort_by=debit.desc 

Liste de valeurs en paramètres de la requête

Pour passer les valeurs ftto et sdsl d'un tableau nommé infrastructure_type en paramètre, le format est le suivant :

https://api.netwo.io/api/v1/endpoint?infrastructure_type[]=ftto&infrastructure_type[]=sdsl 

Erreurs - Codes HTTP

GET

POST

PATCH

DELETE