OAS v3 API Discovery

To retrieve either the basic OAS file or the enriched OAS file with custom field values for a specific API, you must first build the path for the resource.

To build the path for a resource you must retrieve the jsonPath value. This value is provided when you retrieve the list of all available APIs.

To retrieve the list of all available APIs you may use the https://TENANT_NAME.mambu.com/api/swagger/resources endpoint.

The response returns an array of objects. Each object represents an API and includes its jsonPath value.

Next, to retrieve the OAS file for a specific API. See Retrieving OAS v3 Files below.

shell

# You can also use wget
curl -X GET https://TENANT_NAME.mambu.com/api/openapi/resources \
  -u 'username:password'

http

GET https://TENANT_NAME.mambu.com/openapi/swagger/resources HTTP/1.1
Host: TENANT_NAME.mambu.com

Authorization: Basic <credentials>

JS

var headers = {
  'Authorization':'Basic <credentials>'

};

$.ajax({
  url: 'https://TENANT_NAME.mambu.com/openapi/swagger/resources',
  method: 'GET',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

Ruby

require 'rest-client'
require 'json'

headers = {
  'Authorization' => 'Basic <credentials>'
}

result = RestClient.get 'https://TENANT_NAME.mambu.com/openapi/swagger/resources',
  params: {
  }, headers: headers

p JSON.parse(result)

Python

import requests
headers = {
  'Authorization': 'Basic <credentials>'
}

r = requests.get('https://TENANT_NAME.mambu.com/openapi/swagger/resources', params={

}, headers = headers)

print r.json()

Java

URL obj = new URL("https://TENANT_NAME.mambu.com/openapi/swagger/resources");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestProperty("Authorization", "Basic <credentials>");
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Go

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Authorization": []string{"Basic <credentials>"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://TENANT_NAME.mambu.com/openapi/swagger/resources", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Response

[
  {
    "label": "Clients",
    "hashValue": "Clients",
    "index": 0,
    "resourcePaths": [
      {
        "version": "v2",
        "jsonPath": "openapi/resources/clients/v2"
      }
    ]
  },
  {
    "label": "Client Documents",
    "hashValue": "Client_Documents",
    "index": 1,
    "resourcePaths": [
      {
        "version": "v2",
        "jsonPath": "openapi/resources/clients_documents/v2"
      }
    ]
  },
  {
    "label": "Branches",
    "hashValue": "Branches",
    "index": 2,
    "resourcePaths": [
      {
        "version": "v2",
        "jsonPath": "openapi/resources/branches/v2"
      }
    ]
  },
  {
    "label": "Centres",
    "hashValue": "Centres",
    "index": 3,
    "resourcePaths": [
      {
        "version": "v2",
        "jsonPath": "openapi/resources/centres/v2"
      }
    ]
  },
  {
    "label": "Users",
    "hashValue": "Users",
    "index": 4,
    "resourcePaths": [
      {
        "version": "v2",
        "jsonPath": "openapi/resources/users/v2"
      }
    ]
  }
]