Introduction

Axialys fournit une interface applicative (API) pour la gestion des numéros sur le service de Trunk SIP. Afin d'en faciliter l'intégration, cette API est conçue pour se calquer sur l'API REST de Voxbone, avec cependant quelques différences et un subset de fonctionnalités limité;

La documentation de l'API de Voxbone est disponible à l'adresse : https://docs.voxbone.com/api/v3

Authentification

L'authentification sur cette API s'effectue en mode HTTP Basic, grâce à une paire login/mot de passe fournis par Axialys, de façon similaire à l'usage sur l'API Voxbone.

Fonctionnalités disponibles

Les fonctionnalités disponibles sont indiquées ci-après, avec en parallèle leurs équivalents Voxbone. Sauf mention contraire, l'usage en est identique.

Service activation

Endpoint Axialys Endpoint équivalent Voxbone Documentation Voxbone
PUT /vbapi/v1/regulation/addressPUT /ws-voxbone/services/rest/regulation/addresshttps://docs.voxbone.com/api/v3#/reference/service-activation/create-addresses/create-a-new-address
GET /vbapi/v1/regulation/addressGET /ws-voxbone/services/rest/regulation/addresshttps://docs.voxbone.com/api/v3#/reference/service-activation/create-addresses/list-already-created-addresses
PUT /vbapi/v1/regulation/address/<regulationAddressId>/proofPUT /ws-voxbone/services/rest/regulation/address/regulationAddressId/proofhttps://docs.voxbone.com/api/v3#/reference/service-activation/upload-proof-documents-for-an-address/upload-proof-document
GET /vbapi/v1/regulation/zipcodeGET /ws-voxbone/services/rest/regulation/zipcodehttps://docs.voxbone.com/api/v3#/reference/service-activation/list-accepted-postal-codes/list-accepted-postal-codes-for-address-creation-in-a-country
GET /vbapi/v1/regulation/address/<regulationAddressId>/validationGET /ws-voxbone/services/rest/regulation/address/regulationAddressId/validationhttps://docs.voxbone.com/api/v3#/reference/service-activation/check-address-validity-for-activation/check-if-address-is-valid-to-activate-numbers
POST /vbapi/v1/regulation/address/<regulationAddressId>/linkPOST ws-voxbone/services/rest/regulation/address/regulationAddressId/linkhttps://docs.voxbone.com/api/v3#/reference/service-activation/link-numbers-to-a-local-address-requirement-document-for-activation/link-numbers-to-a-local-address-requirement
PUT /vbapi/v1/regulation/address/<regulationAddressId>/verificationPUT /ws-voxbone/services/rest/regulation/address/regulationAddressId/verificationhttps://docs.voxbone.com/api/v3#/reference/service-activation/request-verification-of-changes-to-an-address/request-verification-of-changes-to-an-address
POST /vbapi/v1/regulation/address/unlinkPOST /ws-voxbone/services/rest/regulation/address/unlinkhttps://docs.voxbone.com/api/v3#/reference/service-activation/remove-regulatory-information-from-numbers/remove-address-information-from-numbers
GET /vbapi/v1/regulation/address/<regulationAddressId>/ws-voxbone/services/rest/regulation/address/regulationAddressIdhttps://docs.voxbone.com/api/v3#/reference/service-activation/reuse-or-delete-addresses-lar-for-number-activation/get-a-specific-local-address-requirements-document
DELETE /vbapi/v1/regulation/address/<regulationAddressId>DELETE /ws-voxbone/services/rest/regulation/address/regulationAddressIdhttps://docs.voxbone.com/api/v3#/reference/service-activation/reuse-or-delete-addresses-lar-for-number-activation/remove-a-local-address-requirements-document

Ordering

Endpoint Axialys Endpoint équivalent Voxbone Documentation Voxbone
PUT /vbapi/v1/ordering/cartPUT /ws-voxbone/services/rest/ordering/carthttps://docs.voxbone.com/api/v3#/reference/ordering/create-or-list-carts-for-ordering/create-cart-for-new-orders
POST /vbapi/v1/ordering/cart/<cartIdentifier>/productPOST /ws-voxbone/services/rest/ordering/cart/cartIdentifier/producthttps://docs.voxbone.com/api/v3#/reference/ordering/add-numbers-and-channels-into-cart/add-products-to-cart
GET /vbapi/v1/ordering/cart/<cartIdentifier>/checkoutGET /ws-voxbone/services/rest/ordering/cart/cartIdentifier/checkouthttps://docs.voxbone.com/api/v3#/reference/ordering/checkout-cart-to-buy-numbers-and-channels/checkout-cart

Service coverage