From 9bdb57d435208388d193538c4d6263c469683c2a Mon Sep 17 00:00:00 2001 From: Dave Horton Date: Wed, 2 Jun 2021 08:31:45 -0400 Subject: [PATCH] link to postman for rest api docs --- data/docs.yml | 6 ------ docs/rest/calls.md | 2 +- docs/rest/overview.md | 20 +------------------- docs/rest/postman.md | 4 ++++ 4 files changed, 6 insertions(+), 26 deletions(-) create mode 100644 docs/rest/postman.md diff --git a/data/docs.yml b/data/docs.yml index 71779b0..8f17dda 100644 --- a/data/docs.yml +++ b/data/docs.yml @@ -64,12 +64,6 @@ navi: - path: overview title: Overview - - - path: applications - title: Applications - - - path: calls - title: Calls - path: client-sdks title: Client SDKs diff --git a/docs/rest/calls.md b/docs/rest/calls.md index 473331c..b64a026 100644 --- a/docs/rest/calls.md +++ b/docs/rest/calls.md @@ -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 diff --git a/docs/rest/overview.md b/docs/rest/overview.md index 2a0a06d..39531d6 100644 --- a/docs/rest/overview.md +++ b/docs/rest/overview.md @@ -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 api.jambonz.org, which provides a [postman](https://postman.com) collection that you can use to test against your account on jambonz.us. diff --git a/docs/rest/postman.md b/docs/rest/postman.md new file mode 100644 index 0000000..a7cdbf9 --- /dev/null +++ b/docs/rest/postman.md @@ -0,0 +1,4 @@ +
+ +
+