link to postman for rest api docs

This commit is contained in:
Dave Horton
2021-06-02 08:31:45 -04:00
parent 3d280d21c3
commit 9bdb57d435
4 changed files with 6 additions and 26 deletions
-6
View File
@@ -64,12 +64,6 @@ navi:
-
path: overview
title: Overview
-
path: applications
title: Applications
-
path: calls
title: Calls
-
path: client-sdks
title: Client SDKs
+1 -1
View File
@@ -8,7 +8,7 @@ Calls are created from the REST API by sending an HTTP POST request. A successfu
An example is shown below:
```bash
POST /v1/Accounts/fef61e75-cec3-496c-a7bc-8368e4d02a04/Calls HTTP/1.1
POST https://jambonz.us/v1/Accounts/fef61e75-cec3-496c-a7bc-8368e4d02a04/Calls HTTP/1.1
Content-Length: 175
Accept: application/json
Authorization: Bearer 9404e5f7-9a77-4bcc-b0fa-5665ace28ab3
+1 -19
View File
@@ -1,22 +1,4 @@
# Overview
The jambonz REST API allows applications to query, create, and manage calls and other resources.
**Base URL**
All calls should use the following base URL:
```
https://{serviceUrl}/v1
```
where serviceUrl is set according to your own installation.
**Authentication**
The REST api uses HTTP Bearer Authentication which requires that you include an HTTP Authorization header containing a valid api token.
**Dates and Times**
All dates and times are UTC, using RFC 2822 format.
**Phone Numbers**
All phone numbers are in E.164 format, starting with a plus sign ("+") and the country code.
Full details on the REST API can be found at <a href="https://api.jambonz.org" target="_blank">api.jambonz.org</a>, which provides a [postman](https://postman.com) collection that you can use to test against your account on jambonz.us.
+4
View File
@@ -0,0 +1,4 @@
<div class="video-wrap">
<iframe width="560" height="315" src="https://api.jambonz.org" title="Postman collection" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
</div>