RESTful APIs and SBCs
- 2. 2 Introductions Alan D Percy Chief Marketing Officer alan.percy@telcobridges.com @AlanDPercy Luc Morissette Director of Customer Support luc.morissette@telcobridges.com Pierre-Baptiste Béchu Director of Platform & Infrastructure Aircall.io
- 3. 3 Agenda • Introductions • APIs in the Wild – Aircall.io • RESTful API Overview • How to use REST API with ProSBC • APIs in the Wild – Fusion Networks • Your Questions
- 4. APIs in the Wild Examples of API usage: Aircall.io 4
- 5. 5 Case Study: Aircall • Cloud-based CCaaS • Integrates with CRM and more • Based in Paris France with offices in NYC • Recently secure $65M in Series C funding • 60,000 users around the world • Serving 84 countries • Over 300 employees
- 6. 6 Challenges • Growth plan includes many international geographies • Needed local DIDs in-country, with SBC interfacing service providers to CPaaS infrastructure • Manage 10 SBCs in various AWS centers across Europe, US and Asia • Need to quickly provision, configure and manage SBCs • Automate process for consistency and speed
- 7. 7 Solution • Combination of AWS and ProSBC RESTful APIs • Use AWS API to provision a cloud server instance, activate ProSBC AMI • Once activated, use ProSBC API to download • Configuration and Routing Scripts • Manage software upgrades • Monitor performance
- 8. 8 Results • Fast provisioning • Improved time-to-market • Reduces manual errors • Fits into broader network management strategy • Allows Aircall staff focus on enhancing their application (instead of spending time on the infrastructure)
- 9. RESTful API and ProSBC How to use the RESTful API with ProSBC 9
- 10. 10 RESTful API Overview Web Client Application / Script HTTP/HTML Server GET PUT DELETE HTML methods JSON {…} POST
- 11. 11 ProSBC API Usage Web Admin Program / Script Web Portal Configuration Database POST/GET HTTP/JSON HTTP/HTML ProSBC Applications ProSBC
- 12. 12 ProSBC API Usage Program / Script Configuration Files Centralized Configuration Management HTTP/JSON POST/GET
- 13. 13 Why use APIs with SBCs? Reasons to us APIs to manage SBCs: Automation of SBC configuration To simplify the configuration of large number of units Reduce chance of human error Rapid changes Speeds activation Integration with central management systems (EMS) Logs and diagnostics
- 14. HTTP RESTful API 14 API Parameters HTTP or HTTPS IP/port of the web interface user/password of the web interface Content-Type: application/json HTTP verb: GET, POST, PUT, DELETE Collection/Resource: /configurations/2020_SBC Optional parameters: "name"="to_public"
- 15. HTTP RESTful API 15 Operation HTTP verb Example HTTP path Get the list of resources of a collection GET /configurations Get the content of one resource GET /configurations/2020_SBC Create a new resource POST /configurations/2020_SBC/routes/ {"name":"to_public","nap":"NAP_A4_PRIV", "remapped_nap":"NAP_A5_PUB"} Update an existing resource PUT /configurations/2020_SBC/routes/to_public {"remapped_nap":"NAP_A1"} Delete an existing resource DELETE /configurations/2020_SBC
- 16. 16 Sample route resource GET /configurations/config_test_lanner/routes/to_public { "name": "to_public", "called": "", "calling": "", "nap": "NAP_A4_PRIV", "remapped_nap": "NAP_A1", "remapped_called": "", "remapped_calling": "", ... }
- 17. JSON configuration file Can use a JSON file Pass the whole configuration or segments JSON file Restful HTTP requests Program / Script
- 18. Activating configuration Use put command on target configuration PUT '/systems/system_1' '{"target_configuration":"2020_SBC"}' Activate configuration Program / Script
- 19. Tools and samples tbconfig Compiled tool available on ProSBC https://docs.telcobridges.com/tbwiki/Toolpack_Application:tbconfig Httprestapi.rb Ruby implementation of the RESTful APIs https://docs.telcobridges.com/tbwiki/Northbound_interface:RESTful#Ruby_implementation_example Postman Can create list of HTTP requests Need to set Content-Type to "application/json" https://docs.telcobridges.com/tbwiki/Northbound_interface:RESTful#Postman_tool_integration
- 20. Monitoring GET /status SNMP Failure reports Call information and statistics https://docs.telcobridges.com/tbwiki/SNMP
- 21. Updating files Files can be updated in the File DB Digitmaps Custom files Example" GET /configurations/2020_SBC/file_dbs/File_DB/routesets_digitmaps/digitmaps_1.csv PUT '/configurations/2020_SBC/file_dbs/File DB/routesets_digitmaps/digitmap_1.csv' '{"content":"u00FFcalled,calling,routeset_namern1204,,LABEL_Arn"}'
- 22. APIs in the Wild Examples of API usage: Fusion Networks 22
- 23. Case Study: Fusion Networks • Full-service hosted IP-PBX, SIP Trunking and Internet provider • Based in New York • Serves Eastern Seaboard, USA • Founded in 2015 • Three data centers – 2xNY and one in Virginia • All VMware-based 23 Gabriel Mangieri, CTO
- 24. Challenges • As business grew, capacity and performance limitations with Asterisk softswitch • Serving financial and healthcare markets, need to improve FAX reliability • Call routing become increasingly complex and hard to manage • Suffering from international toll fraud 24
- 25. Solution 25 • Three datacenters, each hosts both a Access and Peering SBC • Each SBC has a 1+1 redundant pair • Route table updates to Peering SBC are remotely updated • RADIUS feeds toll fraud detection s/w Access Peering Subscribers Wholesale Providers 3x Datacenters Program / Script Route Tables RADIUS Route Table Change Toll Fraud Detection
- 26. Video Library on YouTube • ProSBC Training Modules • Recorded webinars • How-to Tutorials • Customer interviews • Frequently Asked Questions • Recorded podcasts • And more… 26 youtube.com/telcobridges
- 27. Live ProSBC Training • Live technical training via Zoom • 16 hours • Three dates/regions • EMEA: October 6-7 • Americas: September 29-30 • APAC: October 20-23 • Includes completion certificate • $100/person 27 Purchase at store.telcobridges.com
- 28. Enabling the Migration to Cloud Communications 28 www.telcobridges.com www.prosbc.com sales@telcobridges.com Youtube.com/telcobridges
- 29. RESTful APIs How to use APIs to manage SBCs for provisioning, configuration and diagnostics
- 30. View the Full-Length Video at: www2.telcobridges.com/videolibrary 30
Editor's Notes
- #3: Some introductions to get started: I’m Alan Percy, Senior Director of Product Marketing for TelcoBridges and today’s event moderator. Joining us again is Luc Morissette, Director of Customer Support and one of the founders of TelcoBridges. Luc, thanks for being a part of today’s event. Before we begin, a little housekeeping: As a live event participant, you’ll have the opportunity to interact with today’s speakers and hope you do pose your questions and comments on today’s topic using the Q/A panel. To pose a question or comment, open the Q/A panel by clicking on the box in the upper left of your screen. We’ll cover your questions toward the end of the session. We’ve found that some attendees may need to adjust the webinar View Options to see the full slide on your screen. If you are not seeing a full slide, move your mouse to the top of the webinar window and a View Option selection will appear – choose an option that best fits your screen. Also, today’s event is being recorded and all those that have registered will received a link to the recording for on-demand playback. We hope you share the link with your co-workers and others that would find the discussion valuable. And we’re glad to have you, our attendees, with us today and encourage you to use the opportunity to interact with our speakers by posing your questions and comments.
- #15: Commands can be recursive
- #16: Commands can be recursive
- #17: To see the configuration of a specific resource or all the configuration
- #20: With each of these tools you can configure the whole system
- #21: Restful APIs is not the best for monitoring, better use SNMP
- #22: Files can be updated with the restful API