Point de terminaison REST
Renseignements sommaires
| Swagger (OpenAPI 2.0): | https://api.thinktel.ca/swagger/ui/swagger.json |
| Swagger UI: | https://api.thinktel.ca/swagger/ui |
| Adresse URL de base: | https://api.thinktel.ca/rest.svc |
| Port: | 443 |
| Cryptage: | TLS 1.0 (suites cryptographiques limitées disponibles), TLS 1.1 (suites cryptographiques limitées disponibles) ou TLS 1.2 |
| Authentification: | Authentification de base sur HTTPS (Basic over HTTPS) |
| Nom d’utilisateur: | {Numéro du client} |
| Mot de passe: | {Mot de passe du client} |
Suivez les liens ci-dessous pour voir des exemples de code REST sur la façon d'ajouter des DID à une liaison SIP existante
Principes du point de terminaison de l’API RESTful.
- Toutes les communications doivent être en HTTPS avec une authentification de base.
- Les noms sont utilisés pour représenter des ressources dans le chemin d’URI.
- Les méthodes de requête HTTP POST, GET, PUT et DELETE doivent mener respectivement à des opérations de création, récupération, mise à jour et suppression.
- Les codes de réponse HTTP (200 OK, 400 requête incorrecte, 500 erreur interne de serveur, etc.) doivent valider la confirmation ou le rejet des requêtes. Dans la mesure du possible, les codes de réponse HTTP dans les séries 400 et 500 doivent fournir les détails de l’exception dans le corps de la réponse.
- Dans la mesure du possible, les en-têtes d’acceptation des requêtes HTTP doivent être respectés en fournissant une réponse dans le format demandé (XML, JSON, etc.).
- Les requêtes POST doivent être utilisées pour créer des ressources et doivent renvoyer une représentation de la ressource lorsqu’elle est créée avec succès.
- Les requêtes GET doivent être utilisées pour obtenir une représentation d’une ou de plusieurs ressources et doivent être idempotentes (autrement dit, sans effet secondaire sur la ou les ressources).
- Les requêtes PUT doivent servir à mettre à jour des ressources, et doivent fournir une représentation de la ressource lorsqu’elle est mise à jour avec succès.
- Les requêtes PUT doivent mettre à jour tous les champs; par conséquent, il est recommandé d’exécuter une requête GET, de mettre à jour les champs requis localement, puis d’exécuter une requête PUT pour mettre à jour la ressource modifiée.
- Les requêtes DELETE doivent servir à supprimer des ressources.
Contenu RESTful : XML ou JSON
Si l’en-tête Accept de la requête HTTP spécifie text/json comme type de contenu, alors JSON est utilisé dans le corps de la réponse HTTP, sinon XML (application/xml; charset=utf-8) est le type de contenu par défaut.
Le corps de la requête HTTP peut être en format text/json ou application/xml pour les requêtes PUT et POST, à condition d’avoir établi le type de contenu (Content-Type) requis dans l’en-tête de la requête HTTP. Notez que le format application/xml ne nécessite de balises de document <?xml … = … ?> standard dans la réponse HTTP ou le corps de la requête, puisque le type de contenu dans l’en-tête HTTP contient déjà cette information. C’est ce qui distingue principalement les formats text/xml et application/xml.